PVUnion has a single subfield. More...

#include "pvData.h"

Inheritance diagram for epics::pvData::PVUnion:

Collaboration diagram for epics::pvData::PVUnion:

Public Types
typedef PVUnion &	reference

typedef const PVUnion &	const_reference

Public Types inherited from epics::pvData::PVField
enum	{ isPVField =1 }

Public Member Functions
	POINTER_DEFINITIONS (PVUnion)

virtual	~PVUnion ()

const UnionConstPtr &	getUnion () const

const PVFieldPtr &	get ()

PVField::const_shared_pointer	get () const

template<typename PVT >
std::tr1::shared_ptr< PVT >	get ()

template<typename PVT >
std::tr1::shared_ptr< const PVT >	get () const

PVFieldPtr	select (int32 index)

template<typename PVT >
std::tr1::shared_ptr< PVT >	select (int32 index)

PVFieldPtr	select (std::string const &fieldName)

template<typename PVT >
std::tr1::shared_ptr< PVT >	select (std::string const &fieldName)

int32	getSelectedIndex () const

std::string	getSelectedFieldName () const

void	set (PVFieldPtr const &value)

void	set (int32 index, PVFieldPtr const &value)

void	set (std::string const &fieldName, PVFieldPtr const &value)

virtual void	serialize (ByteBuffer pbuffer, SerializableControl pflusher) const OVERRIDE FINAL

virtual void	deserialize (ByteBuffer pbuffer, DeserializableControl pflusher) OVERRIDE FINAL

	PVUnion (UnionConstPtr const &punion)

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

void	copy (const PVUnion &from)

void	copyUnchecked (const PVUnion &from)

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

virtual	~PVField ()

const std::string &	getFieldName () const

std::string	getFullName () const

std::size_t	getFieldOffset () const

std::size_t	getNextFieldOffset () const

std::size_t	getNumberFields () const

bool	isImmutable () const

virtual void	setImmutable ()

const FieldConstPtr &	getField () const

PVStructure *	getParent ()

const PVStructure *	getParent () const

void	postPut ()

void	setPostHandler (PostHandlerPtr const &postHandler)

virtual bool	equals (PVField &pv)

void	copy (const PVField &from)

void	copyUnchecked (const PVField &from)

Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()

Static Public Attributes
static const int32	UNDEFINED_INDEX = PVUNION_UNDEFINED_INDEX

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

Friends
class	PVDataCreate

Additional Inherited Members
Protected Member Functions inherited from epics::pvData::PVField
PVField::shared_pointer	getPtrSelf ()

	PVField (FieldConstPtr field)

void	setParentAndName (PVStructure *parent, std::string const &fieldName)

Detailed Description

PVUnion has a single subfield.

The type for the subfield is specified by a union introspection interface.

Definition at line 940 of file pvData.h.

Member Typedef Documentation

typedef const PVUnion& epics::pvData::PVUnion::const_reference

Definition at line 949 of file pvData.h.

typedef PVUnion& epics::pvData::PVUnion::reference

Definition at line 948 of file pvData.h.

Constructor & Destructor Documentation

epics::pvData::PVUnion::~PVUnion ( )

virtual

Destructor

Definition at line 43 of file PVUnion.cpp.

43 {}

epics::pvData::PVUnion::PVUnion ( UnionConstPtr const & punion )

explicit

Constructor

Parameters

punion The introspection interface.

Definition at line 32 of file PVUnion.cpp.

 : PVField(unionPtr),
   unionPtr(unionPtr),
   selector(PVUNION_UNDEFINED_INDEX),    // to allow out-of-order static initialization
   value(),
   variant(unionPtr->isVariant())
 {
 }

Member Function Documentation

void epics::pvData::PVUnion::copy ( const PVUnion & from )

Definition at line 199 of file PVUnion.cpp.

 {
     if(isImmutable())
         throw std::invalid_argument("destination is immutable");
 
     if(*getUnion() != *from.getUnion())
         throw std::invalid_argument("union definitions do not match");
 
     copyUnchecked(from);
 }

void epics::pvData::PVUnion::copyUnchecked ( const PVUnion & from )

Definition at line 210 of file PVUnion.cpp.

 {
 
     const PVField::const_shared_pointer& fromValue = from.get();
     if (from.getUnion()->isVariant())
     {
         if (fromValue.get() == 0)
         {
             set(PVField::shared_pointer());
         }
         else
         {
             PVFieldPtr toValue = get();
             if (toValue.get() == 0 || *toValue->getField() != *fromValue->getField())
             {
                 toValue = pvDataCreate->createPVField(fromValue->getField());
                 toValue->copyUnchecked(*fromValue);
                 set(toValue);
             }
             else
             {
                 toValue->copyUnchecked(*fromValue);
                 postPut();
             }
         }
     }
     else
     {
         if (fromValue.get() == 0)
         {
             select(PVUnion::UNDEFINED_INDEX);
         }
         else
         {
             select(from.getSelectedIndex())->copyUnchecked(*fromValue);
         }
         postPut();
     }
 
 }

void epics::pvData::PVUnion::deserialize	(	ByteBuffer *	pbuffer,
		DeserializableControl *	pflusher
	)

virtual

Deserialize

Parameters

pbuffer	The byte buffer.
pflusher	Interface to call when buffer is empty.

Implements epics::pvData::Serializable.

Definition at line 144 of file PVUnion.cpp.

 {
     if (variant)
     {
         FieldConstPtr field = pcontrol->cachedDeserialize(pbuffer);
         if (field.get())
         {
             // try to reuse existing field instance
             if (!value.get() || *value->getField() != *field)
                 value = pvDataCreate->createPVField(field);
             value->deserialize(pbuffer, pcontrol);
         }
         else
             value.reset();
     }
     else
     {
         int32 previousSelector = selector;
         selector = static_cast<int32>(SerializeHelper::readSize(pbuffer, pcontrol));
         if (selector != UNDEFINED_INDEX)
         {
             if (selector != previousSelector)
             {
                 FieldConstPtr field = unionPtr->getField(selector);
                 // try to reuse existing field instance
                 if (!value.get() || *value->getField() != *field)
                     value = pvDataCreate->createPVField(field);
             }
             value->deserialize(pbuffer, pcontrol);
         }
         else
             value.reset();
     }
 }

std::ostream & epics::pvData::PVUnion::dumpValue ( std::ostream & o ) const

virtual

Puts the PVField raw value to the stream.

Parameters

o	output stream.

Returns: The output stream.

Implements epics::pvData::PVField.

Definition at line 179 of file PVUnion.cpp.

 {
     o << format::indent() << getUnion()->getID() << ' ' << getFieldName() << std::endl;
     {
         format::indent_scope s(o);
         const PVField::const_shared_pointer& fieldField = get();
         if (fieldField.get() == NULL)
           o << format::indent() << "(none)" << std::endl;
         else
         {
             Type type = fieldField->getField()->getType();
             if (type == scalar || type == scalarArray)
                 o << format::indent() << fieldField->getField()->getID() << ' ' << fieldField->getFieldName() << ' ' << *(fieldField.get()) << std::endl;
             else
                 o << *(fieldField.get());
        }
     }
     return o;
 }

const PVFieldPtr& epics::pvData::PVUnion::get ( )

inline

Get the PVField value stored in the field.

Returns: PVField value of field, null if
getSelectedIndex() == UNDEFINED_INDEX
.

Definition at line 968 of file pvData.h.

968 { return value; }

value

Definition: link.h:174

PVField::const_shared_pointer epics::pvData::PVUnion::get ( ) const

inline

Definition at line 969 of file pvData.h.

969 { return value; }

value

Definition: link.h:174

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::pvData::PVUnion::get ( )

inline

Definition at line 972 of file pvData.h.

                                        {
         STATIC_ASSERT(PVT::isPVField); // only allow cast from PVField sub-class
         return std::tr1::dynamic_pointer_cast<PVT>(get());
     }

template<typename PVT >

std::tr1::shared_ptr<const PVT> epics::pvData::PVUnion::get ( ) const

inline

Definition at line 978 of file pvData.h.

                                                    {
         STATIC_ASSERT(PVT::isPVField); // only allow cast from PVField sub-class
         return std::tr1::dynamic_pointer_cast<const PVT>(get());
     }

string epics::pvData::PVUnion::getSelectedFieldName ( ) const

Get selected field name.

Returns: selected field name, empty string if field does not exist.

Definition at line 45 of file PVUnion.cpp.

 {
     // no name for undefined and for variant unions
     if (selector == UNDEFINED_INDEX)
         return string();
     else
         return unionPtr->getFieldName(selector);
 }

int32 epics::pvData::PVUnion::getSelectedIndex ( ) const

inline

Get selected field index.

Returns: selected field index.

Definition at line 1014 of file pvData.h.

1014 { return selector; }

const UnionConstPtr& epics::pvData::PVUnion::getUnion ( ) const

inline

Get the introspection interface

Returns: The interface.

Definition at line 962 of file pvData.h.

962 { return unionPtr; }

epics::pvData::PVUnion::POINTER_DEFINITIONS ( PVUnion )

PVFieldPtr epics::pvData::PVUnion::select ( int32 index )

Select field (set index) and get the field at the index.

Parameters

index index of the field to select.

Returns: corresponding PVField (of undetermined value), null if
index == UNDEFINED_INDEX
.

Exceptions

std::invalid_argument if index is invalid (out of range).

Definition at line 54 of file PVUnion.cpp.

 {
     if (variant && index != UNDEFINED_INDEX)
         throw std::invalid_argument("index out of bounds");
 
     // no change
     if (selector == index && !variant)
         return value;
 
     if (index == UNDEFINED_INDEX)
     {
         selector = UNDEFINED_INDEX;
         value.reset();
         return value;
     }
     else if (index < 0 || size_t(index) >= unionPtr->getFields().size())
         throw std::invalid_argument("index out of bounds");
 
     FieldConstPtr field = unionPtr->getField(index);
     selector = index;
     value = pvDataCreate->createPVField(field);
 
     return value;
 }

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::pvData::PVUnion::select ( int32 index )

inline

Definition at line 992 of file pvData.h.

                                                      {
         STATIC_ASSERT(PVT::isPVField); // only allow cast from PVField sub-class
         return std::tr1::dynamic_pointer_cast<PVT>(select(index));
     }

PVFieldPtr epics::pvData::PVUnion::select ( std::string const & fieldName )

Select field (set index) and get the field by given name.

Parameters

fieldName the name of the field to select.

Returns: corresponding PVField (of undetermined value).

Exceptions

std::invalid_argument if field does not exist.

template<typename PVT >

std::tr1::shared_ptr<PVT> epics::pvData::PVUnion::select ( std::string const & fieldName )

inline

Definition at line 1006 of file pvData.h.

                                                                      {
         return std::tr1::dynamic_pointer_cast<PVT>(select(fieldName));
     }

void epics::pvData::PVUnion::serialize	(	ByteBuffer *	pbuffer,
		SerializableControl *	pflusher
	)		const

virtual

Serialize.

Parameters

pbuffer	The byte buffer.
pflusher	Interface to call when buffer is full.

Implements epics::pvData::Serializable.

Definition at line 121 of file PVUnion.cpp.

 {
     if (variant)
     {
         // write introspection data
         if (value.get() == 0) {
             pflusher->ensureBuffer(1);
             pbuffer->put((int8)-1);
         }else {
             pflusher->cachedSerialize(value->getField(), pbuffer);
             value->serialize(pbuffer, pflusher);
         }
     }
     else
     {
         // write selector value
         SerializeHelper::writeSize(selector, pbuffer, pflusher);
         // write value, no value for UNDEFINED_INDEX
         if (selector != UNDEFINED_INDEX)
             value->serialize(pbuffer, pflusher);
     }
 }

void epics::pvData::PVUnion::set ( PVFieldPtr const & value )

inline

Set the PVField (by reference!) as selected field. If a value is not a valid union field an std::invalid_argument exception is thrown.

Parameters

value the field to set.

Definition at line 1028 of file pvData.h.

                                               {
         set(selector, value);
     }

void epics::pvData::PVUnion::set	(	int32	index,
		PVFieldPtr const &	value
	)

Set the PVField (by reference!) as field at given index. If a value is not a valid union field an std::invalid_argument exception is thrown. Use select(int32) to put by value.

Parameters

index	index of a field to put.
value	the field to set.

See also: select(int32)

Definition at line 87 of file PVUnion.cpp.

 {
     if (variant && index != UNDEFINED_INDEX)
         throw std::invalid_argument("index out of bounds");
     else if (!variant)
     {
         if (index == UNDEFINED_INDEX)
         {
             // for undefined index we accept only null values
             if (value)
                 throw std::invalid_argument("non-null value for index == UNDEFINED_INDEX");
         }
         else if (index < 0 || size_t(index) >= unionPtr->getFields().size())
             throw std::invalid_argument("index out of bounds");
         else if (!value)
             throw std::invalid_argument("Can't set defined index w/ NULL");
         else if (value->getField() != unionPtr->getField(index))
             throw std::invalid_argument("selected field and its introspection data do not match");
     }
 
     selector = index;
     this->value = value;
     postPut();
 }

void epics::pvData::PVUnion::set	(	std::string const &	fieldName,
		PVFieldPtr const &	value
	)

Set the PVField (by reference!) as field by given name. If a value is not a valid union field an std::invalid_argument exception is thrown. Use select(std::string const &) to put by value.

Parameters

fieldName	Name of the field to put.
value	the field to set.

See also: select(std::string const &)

Friends And Related Function Documentation

friend class PVDataCreate

friend

Definition at line 1081 of file pvData.h.

Member Data Documentation

const int32 epics::pvData::PVUnion::UNDEFINED_INDEX = PVUNION_UNDEFINED_INDEX

static

Undefined index. Default value upon PVUnion construction. Can be set by the user. Corresponds to null value.

Definition at line 956 of file pvData.h.

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

modules/pvData/src/pv/pvData.h
modules/pvData/src/factory/PVUnion.cpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation