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

#include "pvIntrospect.h"

Inheritance diagram for epics::pvData::Union:

Collaboration diagram for epics::pvData::Union:

Public Types
typedef Union &	reference

typedef const Union &	const_reference

Public Types inherited from epics::pvData::Field
enum	{ isField =1 }

Public Member Functions
	POINTER_DEFINITIONS (Union)

virtual	~Union ()

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 OVERRIDE FINAL

virtual std::ostream &	dump (std::ostream &o) const OVERRIDE FINAL

virtual void	serialize (ByteBuffer buffer, SerializableControl control) const OVERRIDE FINAL

virtual void	deserialize (ByteBuffer buffer, DeserializableControl control) OVERRIDE FINAL

std::tr1::shared_ptr< PVUnion >	build () const

Public Member Functions inherited from epics::pvData::Field
	POINTER_DEFINITIONS (Field)

virtual	~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 = Union::defaultId()

static const std::string	ANY_ID = Union::anyId()

Static Public Attributes inherited from epics::pvData::Field
static size_t	num_instances

Protected Member Functions
	Union ()

	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 866 of file pvIntrospect.h.

Member Typedef Documentation

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

Definition at line 894 of file pvIntrospect.h.

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

Definition at line 893 of file pvIntrospect.h.

Constructor & Destructor Documentation

epics::pvData::Union::~Union ( )

virtual

Definition at line 731 of file FieldCreateFactory.cpp.

 {
     cacheCleanup();
 }

epics::pvData::Union::Union ( )

protected

Definition at line 682 of file FieldCreateFactory.cpp.

 : Field(union_),
       fieldNames(),
       fields(),
       id(anyId())
 {
 }

epics::pvData::Union::Union	(	StringArray const &	fieldNames,
		FieldConstPtrArray const &	fields,
		std::string const &	id = `defaultId()`
	)

protected

Member Function Documentation

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

static

Get the default variant union ID.

Returns: The default variant union ID.

Definition at line 676 of file FieldCreateFactory.cpp.

 {
     static const string id = "any";
     return id;
 }

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

Allocate a new instance

Version: Added after 7.0.0

Definition at line 882 of file FieldCreateFactory.cpp.

 {
     return getPVDataCreate()->createPVUnion(std::tr1::static_pointer_cast<const Union>(shared_from_this()));
 }

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

static

Get the default union ID.

Returns: The default union ID.

Definition at line 668 of file FieldCreateFactory.cpp.

 {
     static const string id = "union";
     return id;
 }

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

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 878 of file FieldCreateFactory.cpp.

                                                                {
     throw std::runtime_error("not valid operation, use FieldCreate::deserialize instead");
 }

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.

Definition at line 812 of file FieldCreateFactory.cpp.

 {
     o << format::indent() << getID() << std::endl;
     {
         format::indent_scope s(o);
         dumpFields(o);
     }
     return o;
 }

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.

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 914 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         return std::tr1::dynamic_pointer_cast<const FT>(getField(fieldName));
     }

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 952 of file pvIntrospect.h.

952 {return fields.at(index);}

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()

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

Exceptions

std::out_of_range If index >= getNumberFields()

Definition at line 960 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         return std::tr1::dynamic_pointer_cast<const FT>(getField(index));
     }

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.

Definition at line 787 of file FieldCreateFactory.cpp.

                                                          {
     size_t numberFields = fields.size();
     for(size_t i=0; i<numberFields; i++) {
         FieldConstPtr pfield = fields[i];
         int result = fieldName.compare(fieldNames[i]);
         if(result==0) return i;
     }
     return -1;
 }

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 1014 of file pvIntrospect.h.

1014 {return fieldNames.at(fieldIndex);}

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 1008 of file pvIntrospect.h.

1008 {return fieldNames;}

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

inline

Get the fields in the union.

Returns: The array of fields.

Definition at line 1003 of file pvIntrospect.h.

1003 {return fields;}

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 926 of file pvIntrospect.h.

926 {return getFieldImpl(fieldName, true);};

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 934 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         std::tr1::shared_ptr<const FT> result(
             std::tr1::dynamic_pointer_cast<const FT>(getFieldT(fieldName))
         );
 
         if (!result)
             throw std::runtime_error("Wrong Field type");
 
         return result;
     }

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 971 of file pvIntrospect.h.

971 {return fields.at(index);}

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 980 of file pvIntrospect.h.

     {
         STATIC_ASSERT(FT::isField); // only allow cast from Field sub-class
         std::tr1::shared_ptr<const FT> result(
             std::tr1::dynamic_pointer_cast<const FT>(getFieldT(index))
         );
 
         if (!result)
             throw std::runtime_error("Wrong Field type");
 
         return result;
     }

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

virtual

Get the identification string.

Returns: The identification string, can be empty.

Implements epics::pvData::Field.

Definition at line 772 of file FieldCreateFactory.cpp.

 {
     return id;
 }

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 900 of file pvIntrospect.h.

900 {return fieldNames.size();}

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

Definition at line 736 of file FieldCreateFactory.cpp.

 {
     if(t!=scalar && t!=scalarArray)
         THROW_EXCEPTION2(std::logic_error, "PVUnion::guess() only support scalar and scalarArray");
 
     int32 ret = -1;
     for(size_t i=0, N=fields.size(); i<N; i++)
     {
         if(fields[i]->getType()!=t)
             continue;
 
         ScalarType type;
         switch(fields[i]->getType()) {
         case scalar:
             type = static_cast<const Scalar*>(fields[i].get())->getScalarType();
             break;
         case scalarArray:
             type = static_cast<const ScalarArray*>(fields[i].get())->getElementType();
             break;
         default:
             continue;
         }
 
         if(type==s) {
             // exact match
             ret = i;
             break; // we're done
 
         } else if(ret==-1) {
             // first partial match
             ret = i;
         }
     }
     return ret;
 }

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 1019 of file pvIntrospect.h.

1019 {return (fieldNames.size() == 0);}

epics::pvData::Union::POINTER_DEFINITIONS ( Union )

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.

Definition at line 864 of file FieldCreateFactory.cpp.

                                                                             {
     control->ensureBuffer(1);
     if (fields.size() == 0)
     {
         // unrestricted/variant union
         buffer->putByte((int8)0x82);
     }
     else
     {
         buffer->putByte((int8)0x81);
         serializeUnionField(this, buffer, control);
     }
 }

Friends And Related Function Documentation

friend class FieldCreate

friend

Definition at line 1054 of file pvIntrospect.h.

friend class Structure

friend

Definition at line 1055 of file pvIntrospect.h.

Member Data Documentation

const string epics::pvData::Union::ANY_ID = Union::anyId()

static

Default variant union ID.

Definition at line 884 of file pvIntrospect.h.

const string epics::pvData::Union::DEFAULT_ID = Union::defaultId()

static

Default union ID.

Definition at line 873 of file pvIntrospect.h.

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

modules/pvData/src/pv/pvIntrospect.h
modules/pvData/src/factory/FieldCreateFactory.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation