epics::nt::detail::NTScalarBuilder Class Reference

Interface for in-line creating of NTScalar. More...

#include "ntscalar.h"

Inheritance diagram for epics::nt::detail::NTScalarBuilder:

Collaboration diagram for epics::nt::detail::NTScalarBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTScalarBuilder)
shared_pointer	value (epics::pvData::ScalarType scalarType)
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
shared_pointer	addDisplay ()
shared_pointer	addControl ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTScalarPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTScalar

Detailed Description

Interface for in-line creating of NTScalar.

One instance can be used to create multiple instances. An instance of this object must not be used concurrently (an object has a state).

Author

mse

Definition at line 40 of file ntscalar.h.

Member Function Documentation

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::add	(	std::string const &	name,
		epics::pvData::FieldConstPtr const &	field
	)

Adds extra Field to the type.

Parameters

name	the name of the field.
field	the field to be added.

Returns

this instance of NTScalarBuilder.

Definition at line 123 of file ntscalar.cpp.

{
    extraFields.push_back(field); extraFieldNames.push_back(name);
    return shared_from_this();
}

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::addAlarm

(

)

Adds alarm field to the NTScalar.

Returns

this instance of NTScalarBuilder.

Definition at line 74 of file ntscalar.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::addControl

(

)

Adds control field to the NTScalar.

Returns

this instance of NTScalarBuilder.

Definition at line 92 of file ntscalar.cpp.

{
    control = true;
    return shared_from_this();
}

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::addDescriptor

(

)

Adds descriptor field to the NTScalar.

Returns

this instance of NTScalarBuilder.

Definition at line 68 of file ntscalar.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::addDisplay

(

)

Adds display field to the NTScalar.

Returns

this instance of NTScalarBuilder.

Definition at line 86 of file ntscalar.cpp.

{
    display = true;
    return shared_from_this();
}

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTScalar.

Returns

this instance of NTScalarBuilder.

Definition at line 80 of file ntscalar.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTScalarPtr epics::nt::detail::NTScalarBuilder::create

(

)

Creates a NTScalar instance. This resets this instance state and allows new instance to be created.

Returns

a new instance of a NTScalar.

Definition at line 103 of file ntscalar.cpp.

{
    return NTScalarPtr(new NTScalar(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTScalarBuilder::createPVStructure

(

)

Creates a PVStructure that represents NTScalar. This resets this instance state and allows new instance to be created.

Returns

a new instance of a PVStructure.

Definition at line 98 of file ntscalar.cpp.

{
    return getPVDataCreate()->createPVStructure(createStructure());
}

StructureConstPtr epics::nt::detail::NTScalarBuilder::createStructure

(

)

Creates a Structure that represents NTScalar. This resets this instance state and allows new instance to be created.

Returns

a new instance of a Structure.

Definition at line 32 of file ntscalar.cpp.

{
    if (!valueTypeSet)
        throw std::runtime_error("value type not set");

    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTScalar::URI)->
               add("value", valueType);

    if (descriptor)
        builder->add("descriptor", pvString);

    if (alarm)
        builder->add("alarm", ntField->createAlarm());

    if (timeStamp)
        builder->add("timeStamp", ntField->createTimeStamp());

    if (display)
        builder->add("display", ntField->createDisplay());

    if (control)
        builder->add("control", ntField->createControl());

    size_t extraCount = extraFieldNames.size();
    for (size_t i = 0; i< extraCount; i++)
        builder->add(extraFieldNames[i], extraFields[i]);


    StructureConstPtr s = builder->createStructure();

    reset();
    return s;
}

epics::nt::detail::NTScalarBuilder::POINTER_DEFINITIONS

(

NTScalarBuilder

)

NTScalarBuilder::shared_pointer epics::nt::detail::NTScalarBuilder::value

(

epics::pvData::ScalarType

scalarType

)

Sets the value type of an NTScalar.

Parameters

scalarType

the value type.

Returns

this instance of NTScalarBuilder.

Definition at line 22 of file ntscalar.cpp.

{
    valueType = scalarType;
    valueTypeSet = true;

    return shared_from_this();
}

Friends And Related Function Documentation

friend class ::epics::nt::NTScalar

friend

Definition at line 130 of file ntscalar.h.

---

The documentation for this class was generated from the following files:

• modules/normativeTypes/src/pv/ntscalar.h
• modules/normativeTypes/src/ntscalar.cpp