epics::pvData::FieldCreate Class Reference

This is a singleton class for creating introspection interfaces. More...

#include <pv/pvIntrospect.h>

Public Member Functions
FieldBuilderPtr	createFieldBuilder () const
FieldBuilderPtr	createFieldBuilder (StructureConstPtr S) const
ScalarConstPtr	createScalar (ScalarType scalarType) const
BoundedStringConstPtr	createBoundedString (std::size_t maxLength) const EPICS_DEPRECATED
ScalarArrayConstPtr	createScalarArray (ScalarType elementType) const
ScalarArrayConstPtr	createFixedScalarArray (ScalarType elementType, std::size_t size) const EPICS_DEPRECATED
ScalarArrayConstPtr	createBoundedScalarArray (ScalarType elementType, std::size_t bound) const EPICS_DEPRECATED
StructureArrayConstPtr	createStructureArray (StructureConstPtr const &structure) const
StructureConstPtr	createStructure () const
StructureConstPtr	createStructure (StringArray const &fieldNames, FieldConstPtrArray const &fields) const
StructureConstPtr	createStructure (std::string const &id, StringArray const &fieldNames, FieldConstPtrArray const &fields) const
UnionArrayConstPtr	createUnionArray (UnionConstPtr const &punion) const
UnionArrayConstPtr	createVariantUnionArray () const
UnionConstPtr	createVariantUnion () const
UnionConstPtr	createUnion (StringArray const &fieldNames, FieldConstPtrArray const &fields) const
UnionConstPtr	createUnion (std::string const &id, StringArray const &fieldNames, FieldConstPtrArray const &fields) const
StructureConstPtr	appendField (StructureConstPtr const &structure, std::string const &fieldName, FieldConstPtr const &field) const
StructureConstPtr	appendFields (StructureConstPtr const &structure, StringArray const &fieldNames, FieldConstPtrArray const &fields) const
FieldConstPtr	deserialize (ByteBuffer *buffer, DeserializableControl *control) const

Static Public Member Functions
static const FieldCreatePtr &	getFieldCreate ()

Friends
struct	detail::field_factory
class	Field

Detailed Description

This is a singleton class for creating introspection interfaces.

Definition at line 1250 of file pvIntrospect.h.

Member Function Documentation

appendField()

StructureConstPtr epics::pvData::FieldCreate::appendField	(	StructureConstPtr const &	structure,
		std::string const &	fieldName,
		FieldConstPtr const &	field
	)		const

Append a field to a structure.

Parameters

structure	The structure to which the field is appended.
fieldName	The name of the field.
field	The field.

Returns

a Structure interface for the newly created object.

appendFields()

StructureConstPtr epics::pvData::FieldCreate::appendFields	(	StructureConstPtr const &	structure,
		StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields
	)		const

Append fields to a structure.

Parameters

structure	The structure to which the fields appended.
fieldNames	The names of the fields.
fields	The fields.

Returns

a Structure interface for the newly created object.

createBoundedScalarArray()

ScalarArrayConstPtr epics::pvData::FieldCreate::createBoundedScalarArray	(	ScalarType	elementType,
		std::size_t	bound
	)		const

Create an Array field, bounded size array.

Parameters

elementType	The ScalarType for array elements
bound	Array maximum capacity.

Returns

An Array Interface for the newly created object.

createBoundedString()

BoundedStringConstPtr epics::pvData::FieldCreate::createBoundedString

(

std::size_t

maxLength

)

const

Create a BoundedString.

Parameters

maxLength

a string maximum length.

Returns

a BoundedString interface for the newly created object.

Exceptions

IllegalArgumentException

if maxLength == 0.

createFieldBuilder() [1/2]

FieldBuilderPtr epics::pvData::FieldCreate::createFieldBuilder

(

)

const

Create a new instance of in-line Field builder.

Returns

a new instance of a FieldBuilder.

createFieldBuilder() [2/2]

FieldBuilderPtr epics::pvData::FieldCreate::createFieldBuilder

(

StructureConstPtr

S

)

const

Create a new instance of in-line Field builder pre-initialized with and existing Structure

Returns

a new instance of a FieldBuilder.

createScalar()

ScalarConstPtr epics::pvData::FieldCreate::createScalar

(

ScalarType

scalarType

)

const

Create a ScalarField.

Parameters

scalarType

The scalar type.

Returns

a Scalar interface for the newly created object.

Exceptions

IllegalArgumentException

if an illegal type is specified.

createScalarArray()

ScalarArrayConstPtr epics::pvData::FieldCreate::createScalarArray

(

ScalarType

elementType

)

const

Create an Array field, variable size array.

Parameters

elementType

The ScalarType for array elements

Returns

An Array Interface for the newly created object.

createStructure() [1/3]

StructureConstPtr epics::pvData::FieldCreate::createStructure

(

)

const

Create a Structure field.

Returns

a Structure interface for the newly created object.

createStructure() [2/3]

StructureConstPtr epics::pvData::FieldCreate::createStructure	(	StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields
	)		const

Create a Structure field.

Parameters

fieldNames	the names of the fields for the structure.
fields	The array of Field objects for the structure.

Returns

a Structure interface for the newly created object.

createStructure() [3/3]

StructureConstPtr epics::pvData::FieldCreate::createStructure	(	std::string const &	id,
		StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields
	)		const

Create a Structure field with identification string.

Parameters

id	The identification string for the structure.
fieldNames	the names of the fields for the structure.
fields	The array of Field objects for the structure.

Returns

a Structure interface for the newly created object.

createStructureArray()

StructureArrayConstPtr epics::pvData::FieldCreate::createStructureArray

(

StructureConstPtr const &

structure

)

const

Create an Array field that is has element type Structure

Parameters

structure

The Structure for each array element.

Returns

An Array Interface for the newly created object.

createUnion() [1/2]

UnionConstPtr epics::pvData::FieldCreate::createUnion	(	StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields
	)		const

Create a Union field.

Parameters

fieldNames	the names of the fields for the union.
fields	The Field for each fields for the union.

Returns

a Union interface for the newly created object.

createUnion() [2/2]

UnionConstPtr epics::pvData::FieldCreate::createUnion	(	std::string const &	id,
		StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields
	)		const

Create a Union field with identification string.

Parameters

id	The identification string for the union.
fieldNames	the names of the fields for the union.
fields	The array of Field objects for the union.

Returns

a Union interface for the newly created object.

createUnionArray()

UnionArrayConstPtr epics::pvData::FieldCreate::createUnionArray

(

UnionConstPtr const &

punion

)

const

Create an Array field that is has element type Union

Parameters

punion

The Union for each array element.

Returns

An Array Interface for the newly created object.

createVariantUnion()

UnionConstPtr epics::pvData::FieldCreate::createVariantUnion

(

)

const

Create a variant Union (aka any type) field.

Returns

a Union interface for the newly created object.

createVariantUnionArray()

UnionArrayConstPtr epics::pvData::FieldCreate::createVariantUnionArray

(

)

const

Create a variant UnionArray (aka any type) field.

Returns

a UnionArray interface for the newly created object.

deserialize()

FieldConstPtr epics::pvData::FieldCreate::deserialize	(	ByteBuffer *	buffer,
		DeserializableControl *	control
	)		const

Deserialize Field instance from given byte buffer.

Parameters

buffer	Buffer containing serialized Field instance.
control	Deserialization control instance.

Returns

a deserialized Field instance.

---

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

• pv/pvIntrospect.h