Standard Fields is a class or creating or sharing Field objects for standard fields. More...

#include "standardField.h"

Public Member Functions
	~StandardField ()

StructureConstPtr	scalar (ScalarType type, std::string const &properties)

StructureConstPtr	regUnion (UnionConstPtr const &punion, std::string const &properties)

StructureConstPtr	variantUnion (std::string const &properties)

StructureConstPtr	scalarArray (ScalarType elementType, std::string const &properties)

StructureConstPtr	structureArray (StructureConstPtr const &structure, std::string const &properties)

StructureConstPtr	unionArray (UnionConstPtr const &punion, std::string const &properties)

StructureConstPtr	enumerated ()

StructureConstPtr	enumerated (std::string const &properties)

const StructureConstPtr &	alarm () const

const StructureConstPtr &	timeStamp () const

const StructureConstPtr &	display () const

const StructureConstPtr &	control () const

const StructureConstPtr &	booleanAlarm () const

const StructureConstPtr &	byteAlarm () const

const StructureConstPtr &	ubyteAlarm () const

const StructureConstPtr &	shortAlarm () const

const StructureConstPtr &	ushortAlarm () const

const StructureConstPtr &	intAlarm () const

const StructureConstPtr &	uintAlarm () const

const StructureConstPtr &	longAlarm () const

const StructureConstPtr &	ulongAlarm () const

const StructureConstPtr &	floatAlarm () const

const StructureConstPtr &	doubleAlarm () const

const StructureConstPtr &	enumeratedAlarm () const

Static Public Member Functions
static const StandardFieldPtr &	getStandardField ()

Detailed Description

Standard Fields is a class or creating or sharing Field objects for standard fields.

For each type of standard object two methods are defined:s one with no properties and with properties The property field is a comma separated string of property names of the following: alarm, timeStamp, display, control, and valueAlarm. An example is "alarm,timeStamp,valueAlarm". The method with properties creates a structure with fields named fieldName and each of the property names. Each property field is a structure defining the property. The details about each property is given in the section named "Property". For example the call:

StructureConstPtr example = standardField->scalar(
     std::string("value"),
     pvDouble,
     std::string("value,alarm,timeStamp")); 

Will result in a Field definition that has the form:

structure example
  double value
  structure alarm
      int severity
      int status
      string message
 structure timeStamp
      long secondsPastEpoch
      int  nanoseconds
      int userTag

In addition there are methods that create each of the property structures, i.e. the methods named: alarm, .... enumeratedAlarm."

StandardField is a singleton class. The class is accessed via the statement:

StandardField *standardField = getStandardField();

Definition at line 63 of file standardField.h.

Constructor & Destructor Documentation

epics::pvData::StandardField::~StandardField ( )

Definition at line 106 of file StandardField.cpp.

106 {}

Member Function Documentation

const StructureConstPtr& epics::pvData::StandardField::alarm ( ) const

inline

create an alarm structure

Returns: The const shared pointer to the structure.

Definition at line 135 of file standardField.h.

135 { return alarmField; }

const StructureConstPtr& epics::pvData::StandardField::booleanAlarm ( ) const

inline

create a boolean alarm structure

Returns: The const shared pointer to the structure.

Definition at line 155 of file standardField.h.

155 { return booleanAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::byteAlarm ( ) const

inline

create a byte alarm structure

Returns: The const shared pointer to the structure.

Definition at line 160 of file standardField.h.

160 { return byteAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::control ( ) const

inline

create a control structure

Returns: The const shared pointer to the structure.

Definition at line 150 of file standardField.h.

150 { return controlField; }

const StructureConstPtr& epics::pvData::StandardField::display ( ) const

inline

create a display structure

Returns: The const shared pointer to the structure.

Definition at line 145 of file standardField.h.

145 { return displayField; }

const StructureConstPtr& epics::pvData::StandardField::doubleAlarm ( ) const

inline

create a double alarm structure

Returns: The const shared pointer to the structure.

Definition at line 205 of file standardField.h.

205 { return doubleAlarmField; }

StructureConstPtr epics::pvData::StandardField::enumerated ( )

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

Returns: The const shared pointer to the structure.

Definition at line 247 of file StandardField.cpp.

 {
     size_t num = 2;
     FieldConstPtrArray fields(num);
     StringArray names(num);
     names[0] = "index";
     names[1] = "choices";
     fields[0] = fieldCreate->createScalar(pvInt);
     fields[1] = fieldCreate->createScalarArray(pvString);
     return fieldCreate->createStructure("enum_t",names,fields);
     // NOTE: if this method is used to get NTEnum without properties the ID will be wrong!
 }

StructureConstPtr epics::pvData::StandardField::enumerated ( 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

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.

const StructureConstPtr& epics::pvData::StandardField::enumeratedAlarm ( ) const

inline

create an enumerated alarm structure

Returns: The const shared pointer to the structure.

Definition at line 210 of file standardField.h.

210 { return enumeratedAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::floatAlarm ( ) const

inline

create a float alarm structure

Returns: The const shared pointer to the structure.

Definition at line 200 of file standardField.h.

200 { return floatAlarmField; }

const StandardFieldPtr & epics::pvData::StandardField::getStandardField ( )

static

getStandardField returns the singleton.

Returns: Shared pointer to StandardField.

Definition at line 276 of file StandardField.cpp.

 {
     epicsThreadOnce(&stdFieldGblOnce, &StandardField::once, 0);
 
     return *stdFieldGbl;
 }

const StructureConstPtr& epics::pvData::StandardField::intAlarm ( ) const

inline

create an int alarm structure

Returns: The const shared pointer to the structure.

Definition at line 180 of file standardField.h.

180 { return intAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::longAlarm ( ) const

inline

create a long alarm structure

Returns: The const shared pointer to the structure.

Definition at line 190 of file standardField.h.

190 { return longAlarmField; }

StructureConstPtr epics::pvData::StandardField::regUnion	(	UnionConstPtr const &	punion,
		std::string const &	properties
	)

Create a structure that has a union value field.

Parameters

punion	The interface for 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.

Definition at line 209 of file StandardField.cpp.

 {
    return createProperties("epics:nt/NTUnion:1.0",field,properties);
 }

StructureConstPtr epics::pvData::StandardField::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.

Definition at line 202 of file StandardField.cpp.

 {
     ScalarConstPtr field = fieldCreate->createScalar(type); // scalar_t
     return createProperties("epics:nt/NTScalar:1.0",field,properties);
 }

StructureConstPtr epics::pvData::StandardField::scalarArray	(	ScalarType	elementType,
		std::string const &	properties
	)

Create a structure that has a scalarArray value field.

Parameters

elementType	The element 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.

Definition at line 223 of file StandardField.cpp.

 {
     ScalarArrayConstPtr field = fieldCreate->createScalarArray(elementType); // scalar_t[]
     return createProperties("epics:nt/NTScalarArray:1.0",field,properties);
 }

const StructureConstPtr& epics::pvData::StandardField::shortAlarm ( ) const

inline

create a short alarm structure

Returns: The const shared pointer to the structure.

Definition at line 170 of file standardField.h.

170 { return shortAlarmField; }

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

Create a structure that has a structureArray 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.

Definition at line 231 of file StandardField.cpp.

 {
     StructureArrayConstPtr field = fieldCreate->createStructureArray(
         structure);
     return createProperties("epics:nt/NTStructureArray:1.0",field,properties);
 }

const StructureConstPtr& epics::pvData::StandardField::timeStamp ( ) const

inline

create a timeStamp structure

Returns: The const shared pointer to the structure.

Definition at line 140 of file standardField.h.

140 { return timeStampField; }

const StructureConstPtr& epics::pvData::StandardField::ubyteAlarm ( ) const

inline

create a unsigned byte alarm structure

Returns: The const shared pointer to the structure.

Definition at line 165 of file standardField.h.

165 { return ubyteAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::uintAlarm ( ) const

inline

create a unsigned int alarm structure

Returns: The const shared pointer to the structure.

Definition at line 185 of file standardField.h.

185 { return uintAlarmField; }

const StructureConstPtr& epics::pvData::StandardField::ulongAlarm ( ) const

inline

create a unsigned long alarm structure

Returns: The const shared pointer to the structure.

Definition at line 195 of file standardField.h.

195 { return ulongAlarmField; }

StructureConstPtr epics::pvData::StandardField::unionArray	(	UnionConstPtr const &	punion,
		std::string const &	properties
	)

Create a structure that has a unionArray 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".

Returns: The const shared pointer to the structure.

Definition at line 239 of file StandardField.cpp.

 {
     UnionArrayConstPtr field = fieldCreate->createUnionArray(
         punion);
     return createProperties("epics:nt/NTUnionArray:1.0",field,properties);
 }

const StructureConstPtr& epics::pvData::StandardField::ushortAlarm ( ) const

inline

create a unsigned short alarm structure

Returns: The const shared pointer to the structure.

Definition at line 175 of file standardField.h.

175 { return ushortAlarmField; }

StructureConstPtr epics::pvData::StandardField::variantUnion ( std::string const & properties )

Create a structure that has a variant union value field.

Parameters

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.

Definition at line 216 of file StandardField.cpp.

 {
     UnionConstPtr field =  fieldCreate->createVariantUnion();
     return createProperties("epics:nt/NTUnion:1.0",field,properties);
 }

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

modules/pvData/src/pv/standardField.h
modules/pvData/src/factory/StandardField.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation