normativeTypesCPP
Public Member Functions | Friends | List of all members
epics::nt::detail::NTEnumBuilder Class Reference

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

#include <ntenum.h>

Inheritance 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

◆ add()

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

Adds extra Field to the type.

Parameters
namethe name of the field.
fieldthe field to be added.
Returns
this instance of NTEnumBuilder.

Definition at line 92 of file ntenum.cpp.

◆ addAlarm()

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.

◆ addDescriptor()

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.

◆ addTimeStamp()

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.

◆ create()

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.

◆ 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.

◆ 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.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTEnumBuilder::POINTER_DEFINITIONS ( NTEnumBuilder  )

Friends And Related Function Documentation

◆ ::epics::nt::NTEnum

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: