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

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

#include <nttable.h>

Inheritance diagram for epics::nt::detail::NTTableBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTTableBuilder)
 
shared_pointer addColumn (std::string const &name, epics::pvData::ScalarType elementType)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTTablePtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTTable
 

Detailed Description

Interface for in-line creating of NTTable.

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

Member Function Documentation

◆ add()

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

Definition at line 119 of file nttable.cpp.

◆ addAlarm()

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

Adds alarm field to the NTTable.

Returns
this instance of NTTableBuilder.

Definition at line 77 of file nttable.cpp.

◆ addColumn()

NTTableBuilder::shared_pointer epics::nt::detail::NTTableBuilder::addColumn ( std::string const &  name,
epics::pvData::ScalarType  elementType 
)

Adds a column of given Scalar type.

Parameters
namename of the column.
elementTypecolumn type, a scalar array.
Returns
this instance of NTTableBuilder.

Definition at line 23 of file nttable.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTTable.

Returns
this instance of NTTableBuilder.

Definition at line 71 of file nttable.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTTable.

Returns
this instance of NTTableBuilder.

Definition at line 83 of file nttable.cpp.

◆ create()

NTTablePtr epics::nt::detail::NTTableBuilder::create ( )

Creates a NTTable instance. The returned NTTable will wrap a PVStructure which will have labels equal to the column names. This resets this instance state and allows new instance to be created.

Returns
a new instance of NTTable.

Definition at line 100 of file nttable.cpp.

◆ createPVStructure()

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

Creates a PVStructure that represents NTTable. The returned PVStructure will have labels equal to the column names. This resets this instance state and allows new instance to be created.

Returns
a new instance of PVStructure.

Definition at line 89 of file nttable.cpp.

◆ createStructure()

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

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

Returns
a new instance of Structure.

Definition at line 36 of file nttable.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTTableBuilder::POINTER_DEFINITIONS ( NTTableBuilder  )

Friends And Related Function Documentation

◆ ::epics::nt::NTTable

friend class ::epics::nt::NTTable
friend

Definition at line 123 of file nttable.h.


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