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

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

#include <ntmatrix.h>

Inheritance diagram for epics::nt::detail::NTMatrixBuilder:

Public Member Functions

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

Friends

class ::epics::nt::NTMatrix
 

Detailed Description

Interface for in-line creating of NTMatrix.

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

Member Function Documentation

◆ add()

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

Definition at line 111 of file ntmatrix.cpp.

◆ addAlarm()

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

Adds alarm field to the NTMatrix.

Returns
this instance of NTMatrixBuilder.

Definition at line 67 of file ntmatrix.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTMatrix.

Returns
this instance of NTMatrixBuilder.

Definition at line 61 of file ntmatrix.cpp.

◆ addDim()

NTMatrixBuilder::shared_pointer epics::nt::detail::NTMatrixBuilder::addDim ( )

Adds dimension field to the NTMatrix.

Returns
this instance of NTMatrixBuilder.

Definition at line 55 of file ntmatrix.cpp.

◆ addDisplay()

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

Adds display field to the NTMatrix.

Returns
this instance of NTMatrixBuilder.

Definition at line 79 of file ntmatrix.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTMatrix.

Returns
this instance of NTMatrixBuilder.

Definition at line 73 of file ntmatrix.cpp.

◆ create()

NTMatrixPtr epics::nt::detail::NTMatrixBuilder::create ( )

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

Returns
a new instance of NTMatrix.

Definition at line 90 of file ntmatrix.cpp.

◆ createPVStructure()

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

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

Returns
a new instance of PVStructure.

Definition at line 85 of file ntmatrix.cpp.

◆ createStructure()

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

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

Returns
a new instance of Structure.

Definition at line 22 of file ntmatrix.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTMatrixBuilder::POINTER_DEFINITIONS ( NTMatrixBuilder  )

Friends And Related Function Documentation

◆ ::epics::nt::NTMatrix

friend class ::epics::nt::NTMatrix
friend

Definition at line 120 of file ntmatrix.h.


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