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

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

#include <ntscalarArray.h>

Inheritance diagram for epics::nt::detail::NTScalarArrayBuilder:

Public Member Functions

 POINTER_DEFINITIONS (NTScalarArrayBuilder)
 
shared_pointer value (epics::pvData::ScalarType elementType)
 
shared_pointer arrayValue (epics::pvData::ScalarType elementType)
 
shared_pointer addDescriptor ()
 
shared_pointer addAlarm ()
 
shared_pointer addTimeStamp ()
 
shared_pointer addDisplay ()
 
shared_pointer addControl ()
 
epics::pvData::StructureConstPtr createStructure ()
 
epics::pvData::PVStructurePtr createPVStructure ()
 
NTScalarArrayPtr create ()
 
shared_pointer add (std::string const &name, epics::pvData::FieldConstPtr const &field)
 

Friends

class ::epics::nt::NTScalarArray
 

Detailed Description

Interface for in-line creating of NTScalarArray.

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 41 of file ntscalarArray.h.

Member Function Documentation

◆ add()

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

Definition at line 133 of file ntscalarArray.cpp.

◆ addAlarm()

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

Adds alarm field to the NTScalarArray.

Returns
this instance of NTScalarArrayBuilder.

Definition at line 84 of file ntscalarArray.cpp.

◆ addControl()

NTScalarArrayBuilder::shared_pointer epics::nt::detail::NTScalarArrayBuilder::addControl ( )

Adds control field to the NTScalarArray.

Returns
this instance of NTScalarArrayBuilder.

Definition at line 102 of file ntscalarArray.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTScalarArray.

Returns
this instance of NTScalarArrayBuilder.

Definition at line 78 of file ntscalarArray.cpp.

◆ addDisplay()

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

Adds display field to the NTScalarArray.

Returns
this instance of NTScalarArrayBuilder.

Definition at line 96 of file ntscalarArray.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTScalarArray.

Returns
this instance of NTScalarArrayBuilder.

Definition at line 90 of file ntscalarArray.cpp.

◆ arrayValue()

NTScalarArrayBuilder::shared_pointer epics::nt::detail::NTScalarArrayBuilder::arrayValue ( epics::pvData::ScalarType  elementType)

Sets the value type of the NTScalarArray.

Parameters
elementTypethe value field element ScalarType.
Returns
this instance of NTScalarArrayBuilder.
Deprecated:
use value instead.

Definition at line 32 of file ntscalarArray.cpp.

◆ create()

NTScalarArrayPtr epics::nt::detail::NTScalarArrayBuilder::create ( )

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

Returns
a new instance of NTScalarArray.

Definition at line 113 of file ntscalarArray.cpp.

◆ createPVStructure()

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

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

Returns
a new instance of PVStructure.

Definition at line 108 of file ntscalarArray.cpp.

◆ createStructure()

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

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

Returns
a new instance of Structure.

Definition at line 42 of file ntscalarArray.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTScalarArrayBuilder::POINTER_DEFINITIONS ( NTScalarArrayBuilder  )

◆ value()

NTScalarArrayBuilder::shared_pointer epics::nt::detail::NTScalarArrayBuilder::value ( epics::pvData::ScalarType  elementType)

Sets the value type of the NTScalarArray.

Parameters
elementTypethe value field element ScalarType.
Returns
this instance of NTScalarArrayBuilder.

Definition at line 22 of file ntscalarArray.cpp.

Friends And Related Function Documentation

◆ ::epics::nt::NTScalarArray

friend class ::epics::nt::NTScalarArray
friend

Definition at line 139 of file ntscalarArray.h.


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