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

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

#include <ntnameValue.h>

Inheritance diagram for epics::nt::detail::NTNameValueBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTNameValueBuilder)
 
shared_pointer value (epics::pvData::ScalarType scalarType)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTNameValuePtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTNameValue
 

Detailed Description

Interface for in-line creating of NTNameValue.

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 40 of file ntnameValue.h.

Member Function Documentation

◆ add()

NTNameValueBuilder::shared_pointer epics::nt::detail::NTNameValueBuilder::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 105 of file ntnameValue.cpp.

◆ addAlarm()

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

Adds alarm field to the NTNameValue.

Returns
this instance of NTTableBuilder.

Definition at line 68 of file ntnameValue.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTNameValue.

Returns
this instance of NTTableBuilder.

Definition at line 62 of file ntnameValue.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTNameValue.

Returns
this instance of NTTableBuilder.

Definition at line 74 of file ntnameValue.cpp.

◆ create()

NTNameValuePtr epics::nt::detail::NTNameValueBuilder::create ( )

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

Returns
a new instance of NTNameValue

Definition at line 85 of file ntnameValue.cpp.

◆ createPVStructure()

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

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

Returns
a new instance of PVStructure

Definition at line 80 of file ntnameValue.cpp.

◆ createStructure()

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

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

Returns
a new instance of Structure.

Definition at line 32 of file ntnameValue.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTNameValueBuilder::POINTER_DEFINITIONS ( NTNameValueBuilder  )

◆ value()

NTNameValueBuilder::shared_pointer epics::nt::detail::NTNameValueBuilder::value ( epics::pvData::ScalarType  scalarType)

Sets the value array Scalar type.

Parameters
scalarTypethe value field element ScalarType
Returns
this instance of NTTableBuilder.

Definition at line 22 of file ntnameValue.cpp.

Friends And Related Function Documentation

◆ ::epics::nt::NTNameValue

friend class ::epics::nt::NTNameValue
friend

Definition at line 116 of file ntnameValue.h.


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