This class implements introspection object for a union. More...

#include <pv/pvIntrospect.h>

Inheritance diagram for epics::pvData::Union:

[legend]

Collaboration diagram for epics::pvData::Union:

[legend]

Public Types
typedef std::tr1::shared_ptr< Union >	shared_pointer
typedef std::tr1::shared_ptr< const Union >	const_shared_pointer
typedef std::tr1::weak_ptr< Union >	weak_pointer
typedef std::tr1::weak_ptr< const Union >	const_weak_pointer
typedef Union &	reference
typedef const Union &	const_reference
Public Types inherited from epics::pvData::Field
enum	{ isField =1 }
typedef std::tr1::shared_ptr< Field >	shared_pointer
typedef std::tr1::shared_ptr< const Field >	const_shared_pointer
typedef std::tr1::weak_ptr< Field >	weak_pointer
typedef std::tr1::weak_ptr< const Field >	const_weak_pointer

Public Member Functions
std::size_t	getNumberFields () const
FieldConstPtr	getField (std::string const &fieldName) const
template<typename FT>
std::tr1::shared_ptr< const FT >	getField (std::string const &fieldName) const
FieldConstPtr	getFieldT (std::string const &fieldName) const
template<typename FT>
std::tr1::shared_ptr< const FT >	getFieldT (std::string const &fieldName) const
FieldConstPtr	getField (std::size_t index) const
template<typename FT>
std::tr1::shared_ptr< const FT >	getField (std::size_t index) const
FieldConstPtr	getFieldT (std::size_t index) const
template<typename FT>
std::tr1::shared_ptr< const FT >	getFieldT (std::size_t index) const
std::size_t	getFieldIndex (std::string const &fieldName) const
FieldConstPtrArray const &	getFields () const
StringArray const &	getFieldNames () const
std::string	getFieldName (std::size_t fieldIndex) const
bool	isVariant () const
int32	guess (Type t, ScalarType s) const
virtual std::string	getID () const
virtual std::ostream &	dump (std::ostream &o) const
virtual void	serialize (ByteBuffer buffer, SerializableControl control) const
virtual void	deserialize (ByteBuffer buffer, DeserializableControl control)
std::tr1::shared_ptr< PVUnion >	build () const
Public Member Functions inherited from epics::pvData::Field
Type	getType () const
std::tr1::shared_ptr< PVField >	build () const
Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()

Static Public Member Functions
static const std::string &	defaultId ()
static const std::string &	anyId ()

Static Public Attributes
static const std::string	DEFAULT_ID
static const std::string	ANY_ID
Static Public Attributes inherited from epics::pvData::Field
static size_t	num_instances

Protected Member Functions
	Union (StringArray const &fieldNames, FieldConstPtrArray const &fields, std::string const &id=defaultId())
Protected Member Functions inherited from epics::pvData::Field
	Field (Type type)
void	cacheCleanup ()

Friends
class	FieldCreate
class	Structure

Detailed Description

This class implements introspection object for a union.

Definition at line 858 of file pvIntrospect.h.

Member Typedef Documentation

◆ const_reference

typedef const Union& epics::pvData::Union::const_reference

Definition at line 886 of file pvIntrospect.h.

◆ const_shared_pointer

typedef std::tr1::shared_ptr<const Union> epics::pvData::Union::const_shared_pointer

Definition at line 860 of file pvIntrospect.h.

◆ const_weak_pointer

typedef std::tr1::weak_ptr<const Union> epics::pvData::Union::const_weak_pointer

Definition at line 860 of file pvIntrospect.h.

◆ reference

typedef Union& epics::pvData::Union::reference

Definition at line 885 of file pvIntrospect.h.

◆ shared_pointer

typedef std::tr1::shared_ptr<Union> epics::pvData::Union::shared_pointer

Definition at line 860 of file pvIntrospect.h.

◆ weak_pointer

typedef std::tr1::weak_ptr<Union> epics::pvData::Union::weak_pointer

Definition at line 860 of file pvIntrospect.h.

Member Function Documentation

◆ anyId()

const std::string & epics::pvData::Union::anyId ( )

static

Get the default variant union ID.

Returns: The default variant union ID.

◆ build()

std::tr1::shared_ptr< PVUnion > epics::pvData::Union::build ( ) const

Allocate a new instance

Version: Added after 7.0.0

◆ defaultId()

const std::string & epics::pvData::Union::defaultId ( )

static

Get the default union ID.

Returns: The default union ID.

◆ deserialize()

virtual void epics::pvData::Union::deserialize	(	ByteBuffer *	buffer,
		DeserializableControl *	flusher )

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

◆ dump()

virtual std::ostream & epics::pvData::Union::dump ( std::ostream & o ) const

virtual

Puts the string representation to the stream.

Parameters

o	output stream.

Returns: The output stream.

Implements epics::pvData::Field.

◆ getField() [1/4]

template<typename FT>

std::tr1::shared_ptr< const FT > epics::pvData::Union::getField ( std::size_t index ) const

inline

Lookup Field by index, within this Union.

Parameters

index

Index of member in this union.

index>=0 && index<getNumberFields()

epics::pvData::Union::getNumberFields

std::size_t getNumberFields() const

Definition pvIntrospect.h:892

Returns: NULL if member is not a sub-class of FT

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 952 of file pvIntrospect.h.

◆ getField() [2/4]

FieldConstPtr epics::pvData::Union::getField ( std::size_t index ) const

inline

Lookup Field by index, within this Union.

Parameters

index

Index of member in this union.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 944 of file pvIntrospect.h.

◆ getField() [3/4]

template<typename FT>

std::tr1::shared_ptr< const FT > epics::pvData::Union::getField ( std::string const & fieldName ) const

inline

Lookup Field by name and cast to Field sub-class.

Parameters

fieldName Member field name. May not contain '.'

Returns: NULL If no member by this name, or member exists, but has type other than FT.

Definition at line 906 of file pvIntrospect.h.

◆ getField() [4/4]

FieldConstPtr epics::pvData::Union::getField ( std::string const & fieldName ) const

Lookup Field by name

Parameters

fieldName Member field name. May not contain '.'

Returns: NULL if no member by this name.

◆ getFieldIndex()

std::size_t epics::pvData::Union::getFieldIndex ( std::string const & fieldName ) const

Get the field index for the specified fieldName.

Returns: The introspection interface. This will be -1 if the field is not in the union.

◆ getFieldName()

std::string epics::pvData::Union::getFieldName ( std::size_t fieldIndex ) const

inline

Get the name of the field with the specified index;

Parameters

fieldIndex The index of the desired field.

Returns: The fieldName.

Definition at line 1006 of file pvIntrospect.h.

◆ getFieldNames()

StringArray const & epics::pvData::Union::getFieldNames ( ) const

inline

Get the names of the fields in the union.

Returns: The array of fieldNames.

Definition at line 1000 of file pvIntrospect.h.

◆ getFields()

FieldConstPtrArray const & epics::pvData::Union::getFields ( ) const

inline

Get the fields in the union.

Returns: The array of fields.

Definition at line 995 of file pvIntrospect.h.

◆ getFieldT() [1/4]

template<typename FT>

std::tr1::shared_ptr< const FT > epics::pvData::Union::getFieldT ( std::size_t index ) const

inline

Lookup Field by index, within this Structure.

Parameters

index

Index of member in this structure.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range	If index >= getNumberFields()
std::runtime_error	If member is not a sub-class of FT

Definition at line 972 of file pvIntrospect.h.

◆ getFieldT() [2/4]

FieldConstPtr epics::pvData::Union::getFieldT ( std::size_t index ) const

inline

Lookup Field by index, within this Union.

Parameters

index

Index of member in this union.

index>=0 && index<getNumberFields()

Returns: Field pointer (never NULL)

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 963 of file pvIntrospect.h.

◆ getFieldT() [3/4]

template<typename FT>

std::tr1::shared_ptr< const FT > epics::pvData::Union::getFieldT ( std::string const & fieldName ) const

inline

Lookup Field by name and cast to Field sub-class.

Parameters

fieldName Member field name. May not contain '.'

Returns: Field pointer (never NULL)

Exceptions

std::runtime_error If no member by this name, or member exists, but has type other than FT.

Definition at line 926 of file pvIntrospect.h.

◆ getFieldT() [4/4]

FieldConstPtr epics::pvData::Union::getFieldT ( std::string const & fieldName ) const

inline

Lookup Field by name

Parameters

fieldName Member field name. May not contain '.'

Returns: Field pointer (never NULL)

Exceptions

std::runtime_error If no member by this name

Definition at line 918 of file pvIntrospect.h.

◆ getID()

virtual std::string epics::pvData::Union::getID ( ) const

virtual

Get the identification string.

Returns: The identification string, can be empty.

Implements epics::pvData::Field.

◆ getNumberFields()

std::size_t epics::pvData::Union::getNumberFields ( ) const

inline

Get the number of immediate subfields in the union.

Returns: The number of fields.

Definition at line 892 of file pvIntrospect.h.

◆ guess()

int32 epics::pvData::Union::guess	(	Type	t,
		ScalarType	s ) const

Attempt to find an suitable member to stored the specified type.

Returned index is guerenteed to by of specified Type (either scalar or scalarArray). Provided ScalarType is taken as a hint.

Parameters

t	Must be either scalar or scalarArray
s	The preferred ScalarType

Returns: A valid index or -1

◆ isVariant()

bool epics::pvData::Union::isVariant ( ) const

inline

Check if this union is variant union (aka any type).

Returns: true if this union is variant union, otherwise false.

Definition at line 1011 of file pvIntrospect.h.

◆ serialize()

virtual void epics::pvData::Union::serialize	(	ByteBuffer *	buffer,
		SerializableControl *	flusher ) const

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

◆ FieldCreate

friend class FieldCreate

friend

Definition at line 1046 of file pvIntrospect.h.

◆ Structure

friend class Structure

friend

Definition at line 1047 of file pvIntrospect.h.

Member Data Documentation

◆ ANY_ID

const std::string epics::pvData::Union::ANY_ID

static

Default variant union ID.

Definition at line 876 of file pvIntrospect.h.

◆ DEFAULT_ID

const std::string epics::pvData::Union::DEFAULT_ID

static

Default union ID.

Definition at line 865 of file pvIntrospect.h.

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

pv/pvIntrospect.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ const_shared_pointer

◆ const_weak_pointer

◆ reference

◆ shared_pointer

◆ weak_pointer

Member Function Documentation

◆ anyId()

◆ build()

◆ defaultId()

◆ deserialize()

◆ dump()

◆ getField() [1/4]

◆ getField() [2/4]

◆ getField() [3/4]

◆ getField() [4/4]

◆ getFieldIndex()

◆ getFieldName()

◆ getFieldNames()

◆ getFields()

◆ getFieldT() [1/4]

◆ getFieldT() [2/4]

◆ getFieldT() [3/4]

◆ getFieldT() [4/4]

◆ getID()

◆ getNumberFields()

◆ guess()

◆ isVariant()

◆ serialize()

Friends And Related Symbol Documentation

◆ FieldCreate

◆ Structure

Member Data Documentation

◆ ANY_ID

◆ DEFAULT_ID