normativeTypesCPP
Public Member Functions | Static Public Member Functions | Friends | List of all members
epics::nt::NTField Class Reference

Convenience Class for introspection fields of a Normative Type. More...

#include <ntfield.h>

Public Member Functions

 POINTER_DEFINITIONS (NTField)
 
 ~NTField ()
 
bool isEnumerated (epics::pvData::FieldConstPtr const &field)
 
bool isTimeStamp (epics::pvData::FieldConstPtr const &field)
 
bool isAlarm (epics::pvData::FieldConstPtr const &field)
 
bool isDisplay (epics::pvData::FieldConstPtr const &field)
 
bool isAlarmLimit (epics::pvData::FieldConstPtr const &field)
 
bool isControl (epics::pvData::FieldConstPtr const &field)
 
epics::pvData::StructureConstPtr createEnumerated ()
 
epics::pvData::StructureConstPtr createTimeStamp ()
 
epics::pvData::StructureConstPtr createAlarm ()
 
epics::pvData::StructureConstPtr createDisplay ()
 
epics::pvData::StructureConstPtr createControl ()
 
epics::pvData::StructureArrayConstPtr createEnumeratedArray ()
 
epics::pvData::StructureArrayConstPtr createTimeStampArray ()
 
epics::pvData::StructureArrayConstPtr createAlarmArray ()
 

Static Public Member Functions

static NTFieldPtr get ()
 

Friends

class NTAggregate
 
class NTAttribute
 
class NTContinuum
 
class NTEnum
 
class NTHistogram
 
class NTMatrix
 
class NTMultiChannel
 
class NTNameValue
 
class NTNDArray
 
class NTNDArrayAttribute
 
class NTScalar
 
class NTScalarArray
 
class NTScalarMultiChannel
 
class NTTable
 
class NTUnion
 

Detailed Description

Convenience Class for introspection fields of a Normative Type.

Author
mrk

Definition at line 47 of file ntfield.h.

Constructor & Destructor Documentation

◆ ~NTField()

epics::nt::NTField::~NTField ( )
inline

destructor

Definition at line 58 of file ntfield.h.

Member Function Documentation

◆ createAlarm()

StructureConstPtr epics::nt::NTField::createAlarm ( )

Creates an alarm structure.

Returns
an alarm structure.

Definition at line 138 of file ntfield.cpp.

◆ createAlarmArray()

StructureArrayConstPtr epics::nt::NTField::createAlarmArray ( )

Creates an array of alarm structures.

Returns
an array of alarm structures.

Definition at line 164 of file ntfield.cpp.

◆ createControl()

StructureConstPtr epics::nt::NTField::createControl ( )

Creates a control structure.

Returns
a control structure.

Definition at line 148 of file ntfield.cpp.

◆ createDisplay()

StructureConstPtr epics::nt::NTField::createDisplay ( )

Creates a display structure.

Returns
a displayalarm structure.

Definition at line 143 of file ntfield.cpp.

◆ createEnumerated()

StructureConstPtr epics::nt::NTField::createEnumerated ( )

Creates an enumerated structure.

Returns
an enumerated structure.

Definition at line 128 of file ntfield.cpp.

◆ createEnumeratedArray()

StructureArrayConstPtr epics::nt::NTField::createEnumeratedArray ( )

Creates an array of enumerated structures.

Returns
an array of enumerated structures.

Definition at line 153 of file ntfield.cpp.

◆ createTimeStamp()

StructureConstPtr epics::nt::NTField::createTimeStamp ( )

Creates a timeStamp structure.

Returns
a timeStamp structure.

Definition at line 133 of file ntfield.cpp.

◆ createTimeStampArray()

StructureArrayConstPtr epics::nt::NTField::createTimeStampArray ( )

Creates an array of timeStamp structures.

Returns
an array of timeStamp structures.

Definition at line 158 of file ntfield.cpp.

◆ get()

NTFieldPtr epics::nt::NTField::get ( )
static

Gets the single implementation of this class.

Returns
the implementation

Definition at line 18 of file ntfield.cpp.

◆ isAlarm()

bool epics::nt::NTField::isAlarm ( epics::pvData::FieldConstPtr const &  field)

Is field an alarm structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) an alarm structure.

◆ isAlarmLimit()

bool epics::nt::NTField::isAlarmLimit ( epics::pvData::FieldConstPtr const &  field)

Is field an alarmLimit structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) an alarmLimit structure.

◆ isControl()

bool epics::nt::NTField::isControl ( epics::pvData::FieldConstPtr const &  field)

Is field a control structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) a control structure.

◆ isDisplay()

bool epics::nt::NTField::isDisplay ( epics::pvData::FieldConstPtr const &  field)

Is field a display structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) a display structure.

◆ isEnumerated()

bool epics::nt::NTField::isEnumerated ( epics::pvData::FieldConstPtr const &  field)

Is field an enumerated structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) an enumerated structure.

◆ isTimeStamp()

bool epics::nt::NTField::isTimeStamp ( epics::pvData::FieldConstPtr const &  field)

Is field a timeStamp structure.

Parameters
fieldthe field to test.
Returns
(false,true) if field (is not,is) a timeStamp structure.

◆ POINTER_DEFINITIONS()

epics::nt::NTField::POINTER_DEFINITIONS ( NTField  )

Friends And Related Function Documentation

◆ NTAggregate

friend class NTAggregate
friend

Definition at line 163 of file ntfield.h.

◆ NTAttribute

friend class NTAttribute
friend

Definition at line 164 of file ntfield.h.

◆ NTContinuum

friend class NTContinuum
friend

Definition at line 165 of file ntfield.h.

◆ NTEnum

friend class NTEnum
friend

Definition at line 166 of file ntfield.h.

◆ NTHistogram

friend class NTHistogram
friend

Definition at line 167 of file ntfield.h.

◆ NTMatrix

friend class NTMatrix
friend

Definition at line 168 of file ntfield.h.

◆ NTMultiChannel

friend class NTMultiChannel
friend

Definition at line 169 of file ntfield.h.

◆ NTNameValue

friend class NTNameValue
friend

Definition at line 170 of file ntfield.h.

◆ NTNDArray

friend class NTNDArray
friend

Definition at line 171 of file ntfield.h.

◆ NTNDArrayAttribute

friend class NTNDArrayAttribute
friend

Definition at line 172 of file ntfield.h.

◆ NTScalar

friend class NTScalar
friend

Definition at line 173 of file ntfield.h.

◆ NTScalarArray

friend class NTScalarArray
friend

Definition at line 174 of file ntfield.h.

◆ NTScalarMultiChannel

friend class NTScalarMultiChannel
friend

Definition at line 175 of file ntfield.h.

◆ NTTable

friend class NTTable
friend

Definition at line 176 of file ntfield.h.

◆ NTUnion

friend class NTUnion
friend

Definition at line 177 of file ntfield.h.


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