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

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

#include <ntndarray.h>

Inheritance diagram for epics::nt::detail::NTNDArrayBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTNDArrayBuilder)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
shared_pointer addDisplay ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTNDArrayPtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTNDArray
 

Detailed Description

Interface for in-line creating of NTNDArray.

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 43 of file ntndarray.h.

Member Function Documentation

◆ add()

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::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 a NTArrayBuilder.

Definition at line 189 of file ntndarray.cpp.

References epics::nt::ntAttrStr().

◆ addAlarm()

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

Adds alarm field to the NTNDArray.

Returns
this instance of NTNDArrayBuilder.

Definition at line 146 of file ntndarray.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTNDArray.

Returns
this instance of NTNDArrayBuilder.

Definition at line 140 of file ntndarray.cpp.

◆ addDisplay()

NTNDArrayBuilder::shared_pointer epics::nt::detail::NTNDArrayBuilder::addDisplay ( )

Adds display field to the NTNDArray.

Returns
this instance of NTNDArrayBuilder.

Definition at line 158 of file ntndarray.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTNDArray.

Returns
this instance of NTNDArrayBuilder.

Definition at line 152 of file ntndarray.cpp.

◆ create()

NTNDArrayPtr epics::nt::detail::NTNDArrayBuilder::create ( )

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

Returns
a new instance of a NTNDArray

Definition at line 169 of file ntndarray.cpp.

◆ createPVStructure()

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

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

Returns
a new instance of a PVStructure

Definition at line 164 of file ntndarray.cpp.

◆ createStructure()

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

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

Returns
a new instance of a Structure.

Definition at line 31 of file ntndarray.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTNDArrayBuilder::POINTER_DEFINITIONS ( NTNDArrayBuilder  )

Friends And Related Function Documentation

◆ ::epics::nt::NTNDArray

friend class ::epics::nt::NTNDArray
friend

Definition at line 116 of file ntndarray.h.


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