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

Interface for in-line creating of NTAttribute extended as required by NTNDArray. More...

#include <ntndarrayAttribute.h>

Inheritance diagram for epics::nt::detail::NTNDArrayAttributeBuilder:

Public Member Functions

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

Protected Member Functions

 NTNDArrayAttributeBuilder ()
 
void reset ()
 

Protected Attributes

bool tags
 
bool descriptor
 
bool alarm
 
bool timeStamp
 
epics::pvData::StringArray extraFieldNames
 
epics::pvData::FieldConstPtrArray extraFields
 

Friends

class ::epics::nt::NTNDArrayAttribute
 

Detailed Description

Interface for in-line creating of NTAttribute extended as required by 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
dgh

Definition at line 38 of file ntndarrayAttribute.h.

Constructor & Destructor Documentation

◆ NTNDArrayAttributeBuilder()

epics::nt::detail::NTNDArrayAttributeBuilder::NTNDArrayAttributeBuilder ( )
protected

Definition at line 91 of file ntndarrayAttribute.cpp.

Member Function Documentation

◆ add()

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

Definition at line 106 of file ntndarrayAttribute.cpp.

◆ addAlarm()

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

Adds alarm field to the NTNDArrayAttribute.

Returns
this instance of NTNDArrayAttributeBuilder.

Definition at line 69 of file ntndarrayAttribute.cpp.

◆ addDescriptor()

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

Adds descriptor field to the NTNDArrayAttribute.

Returns
this instance of NTNDArrayAttributeBuilder.

Definition at line 63 of file ntndarrayAttribute.cpp.

◆ addTags()

NTNDArrayAttributeBuilder::shared_pointer epics::nt::detail::NTNDArrayAttributeBuilder::addTags ( )

Adds tags field to the NTNDArrayAttribute.

Returns
this instance of NTNDArrayAttributeBuilder.

Definition at line 57 of file ntndarrayAttribute.cpp.

◆ addTimeStamp()

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

Adds timeStamp field to the NTNDArrayAttribute.

Returns
this instance of NTNDArrayAttributeBuilder.

Definition at line 75 of file ntndarrayAttribute.cpp.

◆ create()

NTNDArrayAttributePtr epics::nt::detail::NTNDArrayAttributeBuilder::create ( )

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

Returns
a new instance of a NTNDArrayAttribute.

Definition at line 86 of file ntndarrayAttribute.cpp.

◆ createPVStructure()

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

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

Returns
a new instance of a PVStructure.

Definition at line 81 of file ntndarrayAttribute.cpp.

◆ createStructure()

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

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

Returns
a new instance of a Structure.

Definition at line 23 of file ntndarrayAttribute.cpp.

◆ POINTER_DEFINITIONS()

epics::nt::detail::NTNDArrayAttributeBuilder::POINTER_DEFINITIONS ( NTNDArrayAttributeBuilder  )

◆ reset()

void epics::nt::detail::NTNDArrayAttributeBuilder::reset ( )
protected

Definition at line 96 of file ntndarrayAttribute.cpp.

Friends And Related Function Documentation

◆ ::epics::nt::NTNDArrayAttribute

friend class ::epics::nt::NTNDArrayAttribute
friend

Definition at line 111 of file ntndarrayAttribute.h.

Member Data Documentation

◆ alarm

bool epics::nt::detail::NTNDArrayAttributeBuilder::alarm
protected

Definition at line 104 of file ntndarrayAttribute.h.

◆ descriptor

bool epics::nt::detail::NTNDArrayAttributeBuilder::descriptor
protected

Definition at line 103 of file ntndarrayAttribute.h.

◆ extraFieldNames

epics::pvData::StringArray epics::nt::detail::NTNDArrayAttributeBuilder::extraFieldNames
protected

Definition at line 108 of file ntndarrayAttribute.h.

◆ extraFields

epics::pvData::FieldConstPtrArray epics::nt::detail::NTNDArrayAttributeBuilder::extraFields
protected

Definition at line 109 of file ntndarrayAttribute.h.

◆ tags

bool epics::nt::detail::NTNDArrayAttributeBuilder::tags
protected

Definition at line 102 of file ntndarrayAttribute.h.

◆ timeStamp

bool epics::nt::detail::NTNDArrayAttributeBuilder::timeStamp
protected

Definition at line 105 of file ntndarrayAttribute.h.


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