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

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

inline

destructor

Definition at line 58 of file ntfield.h.

{}

Member Function Documentation

StructureConstPtr epics::nt::NTField::createAlarm

(

)

Creates an alarm structure.

Returns

an alarm structure.

Definition at line 138 of file ntfield.cpp.

{
    return standardField->alarm();
}

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.

{
    StructureConstPtr st = createAlarm();
    return fieldCreate->createStructureArray(st);
}

StructureConstPtr epics::nt::NTField::createControl

(

)

Creates a control structure.

Returns

a control structure.

Definition at line 148 of file ntfield.cpp.

{
    return standardField->control();
}

StructureConstPtr epics::nt::NTField::createDisplay

(

)

Creates a display structure.

Returns

a displayalarm structure.

Definition at line 143 of file ntfield.cpp.

{
    return standardField->display();
}

StructureConstPtr epics::nt::NTField::createEnumerated

(

)

Creates an enumerated structure.

Returns

an enumerated structure.

Definition at line 128 of file ntfield.cpp.

{
    return standardField->enumerated();
}

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.

{
    return fieldCreate->createStructureArray(createEnumerated());
}

StructureConstPtr epics::nt::NTField::createTimeStamp

(

)

Creates a timeStamp structure.

Returns

a timeStamp structure.

Definition at line 133 of file ntfield.cpp.

{
    return standardField->timeStamp();
}

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.

{
    StructureConstPtr st = createTimeStamp();
    return fieldCreate->createStructureArray(st);
}

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

static

Gets the single implementation of this class.

Returns

the implementation

Definition at line 18 of file ntfield.cpp.

{
    static Mutex mutex;
    static NTFieldPtr ntstructureField;
    Lock xx(mutex);
    if(ntstructureField.get()==NULL) {
         ntstructureField = NTFieldPtr(new NTField());
    }
    return ntstructureField;
}

bool epics::nt::NTField::isAlarm

(

epics::pvData::FieldConstPtr const &

field

)

Is field an alarm structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) an alarm structure.

Definition at line 70 of file ntfield.cpp.

{
    Result result(field);
    return isAlarm(result.is<Structure>()).valid();
}

bool epics::nt::NTField::isAlarmLimit

(

epics::pvData::FieldConstPtr const &

field

)

Is field an alarmLimit structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) an alarmLimit structure.

Definition at line 108 of file ntfield.cpp.

{
    Result result(field);
    return isAlarmLimit(result.is<Structure>()).valid();
}

bool epics::nt::NTField::isControl

(

epics::pvData::FieldConstPtr const &

field

)

Is field a control structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) a control structure.

Definition at line 122 of file ntfield.cpp.

{
    Result result(field);
    return isControl(result.is<Structure>()).valid();
}

bool epics::nt::NTField::isDisplay

(

epics::pvData::FieldConstPtr const &

field

)

Is field a display structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) a display structure.

Definition at line 87 of file ntfield.cpp.

{
    Result result(field);
    return isDisplay(result.is<Structure>()).valid();
}

bool epics::nt::NTField::isEnumerated

(

epics::pvData::FieldConstPtr const &

field

)

Is field an enumerated structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) an enumerated structure.

Definition at line 42 of file ntfield.cpp.

{
    Result result(field);
    return isEnumerated(result.is<Structure>()).valid();
}

bool epics::nt::NTField::isTimeStamp

(

epics::pvData::FieldConstPtr const &

field

)

Is field a timeStamp structure.

Parameters

field

the field to test.

Returns

(false,true) if field (is not,is) a timeStamp structure.

Definition at line 56 of file ntfield.cpp.

{
    Result result(field);
    return isTimeStamp(result.is<Structure>()).valid();
}

epics::nt::NTField::POINTER_DEFINITIONS

(

NTField

)

Friends And Related Function Documentation

friend class NTAggregate

friend

Definition at line 163 of file ntfield.h.

friend class NTAttribute

friend

Definition at line 164 of file ntfield.h.

friend class NTContinuum

friend

Definition at line 165 of file ntfield.h.

friend class NTEnum

friend

Definition at line 166 of file ntfield.h.

friend class NTHistogram

friend

Definition at line 167 of file ntfield.h.

friend class NTMatrix

friend

Definition at line 168 of file ntfield.h.

friend class NTMultiChannel

friend

Definition at line 169 of file ntfield.h.

friend class NTNameValue

friend

Definition at line 170 of file ntfield.h.

friend class NTNDArray

friend

Definition at line 171 of file ntfield.h.

friend class NTNDArrayAttribute

friend

Definition at line 172 of file ntfield.h.

friend class NTScalar

friend

Definition at line 173 of file ntfield.h.

friend class NTScalarArray

friend

Definition at line 174 of file ntfield.h.

friend class NTScalarMultiChannel

friend

Definition at line 175 of file ntfield.h.

friend class NTTable

friend

Definition at line 176 of file ntfield.h.

friend class NTUnion

friend

Definition at line 177 of file ntfield.h.

---

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

• modules/normativeTypes/src/pv/ntfield.h
• modules/normativeTypes/src/ntfield.cpp