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

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

#include <ntunion.h>

Inheritance diagram for epics::nt::detail::NTUnionBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTUnionBuilder)
 
shared_pointer value (epics::pvData::UnionConstPtr unionType)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTUnionPtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTUnion
 

Detailed Description

Interface for in-line creating of NTUnion.

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 ntunion.h.

Member Function Documentation

◆ add()

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

Definition at line 99 of file ntunion.cpp.

◆ addAlarm()

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addAlarm ( )

Adds alarm field to the NTUnion.

Returns
this instance of NTUnionBuilder.

Definition at line 62 of file ntunion.cpp.

◆ addDescriptor()

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addDescriptor ( )

Adds descriptor field to the NTUnion.

Returns
this instance of NTUnionBuilder.

Definition at line 56 of file ntunion.cpp.

◆ addTimeStamp()

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::addTimeStamp ( )

Adds timeStamp field to the NTUnion.

Returns
this instance of NTUnionBuilder.

Definition at line 68 of file ntunion.cpp.

◆ create()

NTUnionPtr epics::nt::detail::NTUnionBuilder::create ( )

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

Returns
a new instance of a NTUnion.

Definition at line 79 of file ntunion.cpp.

◆ createPVStructure()

PVStructurePtr epics::nt::detail::NTUnionBuilder::createPVStructure ( )

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

Returns
a new instance of a PVStructure.

Definition at line 74 of file ntunion.cpp.

◆ createStructure()

StructureConstPtr epics::nt::detail::NTUnionBuilder::createStructure ( )

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

Returns
a new instance of a Structure.

Definition at line 29 of file ntunion.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTUnionBuilder::POINTER_DEFINITIONS ( NTUnionBuilder  )

◆ value()

NTUnionBuilder::shared_pointer epics::nt::detail::NTUnionBuilder::value ( epics::pvData::UnionConstPtr  unionType)

Specifies the union for the value field. If this is not called then a variant union is the default.

Parameters
unionTypethe introspection object for the union value field
Returns
this instance of NTUnionBuilder

Definition at line 23 of file ntunion.cpp.

Friends And Related Function Documentation

◆ ::epics::nt::NTUnion

friend class ::epics::nt::NTUnion
friend

Definition at line 112 of file ntunion.h.


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