epics::nt::detail::NTEnumBuilder Class Reference

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

#include "ntenum.h"

Inheritance diagram for epics::nt::detail::NTEnumBuilder:

Collaboration diagram for epics::nt::detail::NTEnumBuilder:

Public Member Functions
	POINTER_DEFINITIONS (NTEnumBuilder)
shared_pointer	addDescriptor ()
shared_pointer	addAlarm ()
shared_pointer	addTimeStamp ()
epics::pvData::StructureConstPtr	createStructure ()
epics::pvData::PVStructurePtr	createPVStructure ()
NTEnumPtr	create ()
shared_pointer	add (std::string const &name, epics::pvData::FieldConstPtr const &field)

Friends
class	::epics::nt::NTEnum

Detailed Description

Interface for in-line creating of NTEnum.

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

dgh

Definition at line 37 of file ntenum.h.

Member Function Documentation

NTEnumBuilder::shared_pointer epics::nt::detail::NTEnumBuilder::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 NTEnumBuilder.

Definition at line 92 of file ntenum.cpp.

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

NTEnumBuilder::shared_pointer epics::nt::detail::NTEnumBuilder::addAlarm

(

)

Adds alarm field to the NTEnum.

Returns

this instance of NTEnumBuilder.

Definition at line 56 of file ntenum.cpp.

{
    alarm = true;
    return shared_from_this();
}

NTEnumBuilder::shared_pointer epics::nt::detail::NTEnumBuilder::addDescriptor

(

)

Adds descriptor field to the NTEnum.

Returns

this instance of NTEnumBuilder.

Definition at line 50 of file ntenum.cpp.

{
    descriptor = true;
    return shared_from_this();
}

NTEnumBuilder::shared_pointer epics::nt::detail::NTEnumBuilder::addTimeStamp

(

)

Adds timeStamp field to the NTEnum.

Returns

this instance of NTEnumBuilder.

Definition at line 62 of file ntenum.cpp.

{
    timeStamp = true;
    return shared_from_this();
}

NTEnumPtr epics::nt::detail::NTEnumBuilder::create

(

)

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

Returns

a new instance of a NTEnum.

Definition at line 73 of file ntenum.cpp.

{
    return NTEnumPtr(new NTEnum(createPVStructure()));
}

PVStructurePtr epics::nt::detail::NTEnumBuilder::createPVStructure

(

)

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

Returns

a new instance of a PVStructure.

Definition at line 68 of file ntenum.cpp.

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

StructureConstPtr epics::nt::detail::NTEnumBuilder::createStructure

(

)

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

Returns

a new instance of a Structure.

Definition at line 23 of file ntenum.cpp.

{
    FieldBuilderPtr builder =
            getFieldCreate()->createFieldBuilder()->
               setId(NTEnum::URI)->
               add("value", ntField->createEnumerated());

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

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

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

    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::NTEnumBuilder::POINTER_DEFINITIONS

(

NTEnumBuilder

)

Friends And Related Function Documentation

friend class ::epics::nt::NTEnum

friend

Definition at line 103 of file ntenum.h.

---

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

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