epics::pvData::StandardPVField Class Reference

StandardPVField is a class or creating standard data fields. More...

#include <pv/standardPVField.h>

Public Member Functions
PVStructurePtr	scalar (ScalarType type, std::string const &properties)
PVStructurePtr	scalarArray (ScalarType elementType, std::string const &properties)
PVStructurePtr	structureArray (StructureConstPtr const &structure, std::string const &properties)
PVStructurePtr	unionArray (UnionConstPtr const &punion, std::string const &properties)
PVStructurePtr	enumerated (StringArray const &choices)
PVStructurePtr	enumerated (StringArray const &choices, std::string const &properties)

Static Public Member Functions
static StandardPVFieldPtr	getStandardPVField ()

Detailed Description

StandardPVField is a class or creating standard data fields.

Like class StandardField it has two forms of the methods which create a fields: one without properties and one with properties. The properties are some combination of alarm, timeStamp, control, display, and valueAlarm. Just like StandardField there are methods to create the standard properties.

StandardPVField is a singleton class. The class is accessed via the statement:
StandardPVField *standardPVField = getStandardPVField();


Definition at line 38 of file standardPVField.h.

Member Function Documentation

enumerated() [1/2]

PVStructurePtr epics::pvData::StandardPVField::enumerated

(

StringArray const &

choices

)

Create a structure that has an enumerated structure value field. The id for the structure is "enum_t".

Parameters

choices

This is a StringArray of choices.

Returns

The const shared pointer to the structure.

enumerated() [2/2]

PVStructurePtr epics::pvData::StandardPVField::enumerated	(	StringArray const &	choices,
		std::string const &	properties )

Create a structure that has an enumerated structure value field. The id for the structure is "epics:nt/NTEnum:1.0".

Parameters

choices	This is a StringArray of choices.
properties	A comma separated list of properties.

Returns

The const shared pointer to the structure.

getStandardPVField()

static StandardPVFieldPtr epics::pvData::StandardPVField::getStandardPVField ( )

static

getStandardPVField returns the singleton.

Returns

Shared pointer to StandardPVField.

scalar()

PVStructurePtr epics::pvData::StandardPVField::scalar	(	ScalarType	type,
		std::string const &	properties )

Create a structure that has a scalar value field.

Parameters

type	The type.
properties	A comma separated list of properties. This is some combination of "alarm,timeStamp,display,control,valueAlarm".

Returns

The const shared pointer to the structure.

scalarArray()

PVStructurePtr epics::pvData::StandardPVField::scalarArray	(	ScalarType	elementType,
		std::string const &	properties )

Create a structure that has a scalar array value field.

Parameters

elementType	The element scalar type.
properties	A comma separated list of properties. This is some combination of "alarm,timeStamp,display,control,valueAlarm".

Returns

The const shared pointer to the structure.

structureArray()

PVStructurePtr epics::pvData::StandardPVField::structureArray	(	StructureConstPtr const &	structure,
		std::string const &	properties )

Create a structure that has a structure array value field.

Parameters

structure	The Structure introspection object for elements of the value field.
properties	A comma separated list of properties. This is some combination of "alarm,timeStamp,display,control,valueAlarm".

Returns

The const shared pointer to the structure.

unionArray()

PVStructurePtr epics::pvData::StandardPVField::unionArray	(	UnionConstPtr const &	punion,
		std::string const &	properties )

Create a structure that has a union array value field.

Parameters

punion	The Union introspection object for elements of the value field.
properties	A comma separated list of properties. This is some combination of "alarm,timeStamp,display,control,valueAlarm".

Returns

The const shared pointer to the structure.

---

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

• pv/standardPVField.h