Data interface for a structure,. More...

#include "pvData.h"

Inheritance diagram for epics::pvData::PVStructure:

Collaboration diagram for epics::pvData::PVStructure:

Classes
struct	Formatter

Public Types
typedef PVStructure &	reference

typedef const PVStructure &	const_reference

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

Public Member Functions
	POINTER_DEFINITIONS (PVStructure)

virtual	~PVStructure ()

virtual void	setImmutable () OVERRIDE FINAL

const StructureConstPtr &	getStructure () const

const PVFieldPtrArray &	getPVFields () const

template<typename A >
FORCE_INLINE std::tr1::shared_ptr< PVField >	getSubField (A a)

template<typename A >
FORCE_INLINE std::tr1::shared_ptr< const PVField >	getSubField (A a) const

template<typename PVD , typename A >
std::tr1::shared_ptr< PVD >	getSubField (A a)

template<typename PVD , typename A >
std::tr1::shared_ptr< const PVD >	getSubField (A a) const

template<typename A >
FORCE_INLINE std::tr1::shared_ptr< PVField >	getSubFieldT (A a)

template<typename A >
FORCE_INLINE std::tr1::shared_ptr< const PVField >	getSubFieldT (A a) const

template<typename PVD , typename A >
std::tr1::shared_ptr< PVD >	getSubFieldT (A a)

template<typename PVD , typename A >
std::tr1::shared_ptr< const PVD >	getSubFieldT (A a) const

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

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

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

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

	PVStructure (StructureConstPtr const &structure)

	PVStructure (StructureConstPtr const &structure, PVFieldPtrArray const &pvFields)

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

void	copy (const PVStructure &from)

void	copyUnchecked (const PVStructure &from)

void	copyUnchecked (const PVStructure &from, const BitSet &maskBitSet, bool inverse=false)

FORCE_INLINE Formatter	stream () const

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

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

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

Friends
class	PVDataCreate

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

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

Data interface for a structure,.

Definition at line 712 of file pvData.h.

Member Typedef Documentation

typedef const PVStructure& epics::pvData::PVStructure::const_reference

Definition at line 721 of file pvData.h.

typedef PVStructure& epics::pvData::PVStructure::reference

Definition at line 720 of file pvData.h.

Constructor & Destructor Documentation

epics::pvData::PVStructure::~PVStructure ( )

virtual

Destructor

Definition at line 63 of file PVStructure.cpp.

63 {}

epics::pvData::PVStructure::PVStructure ( StructureConstPtr const & structure )

explicit

Constructor

Parameters

structure The introspection interface.

Definition at line 27 of file PVStructure.cpp.

 : PVField(structurePtr),
   structurePtr(structurePtr),
   extendsStructureName("")
 {
     size_t numberFields = structurePtr->getNumberFields();
     FieldConstPtrArray const & fields = structurePtr->getFields();
     StringArray const & fieldNames = structurePtr->getFieldNames();
     pvFields.reserve(numberFields);
     PVDataCreatePtr pvDataCreate = getPVDataCreate();
     for(size_t i=0; i<numberFields; i++) {
         pvFields.push_back(pvDataCreate->createPVField(fields[i]));
     }
     for(size_t i=0; i<numberFields; i++) {
         pvFields[i]->setParentAndName(this,fieldNames[i]);
     }
 }

epics::pvData::PVStructure::PVStructure	(	StructureConstPtr const &	structure,
		PVFieldPtrArray const &	pvFields
	)

Constructor

Parameters

structure	The introspection interface.
pvFields	The array of fields for the structure.

Definition at line 45 of file PVStructure.cpp.

 : PVField(structurePtr),
   structurePtr(structurePtr),
   extendsStructureName("")
 {
     size_t numberFields = structurePtr->getNumberFields();
     StringArray const & fieldNames = structurePtr->getFieldNames();
     pvFields.reserve(numberFields);
     for(size_t i=0; i<numberFields; i++) {
         pvFields.push_back(pvs[i]);
     }
     for(size_t i=0; i<numberFields; i++) {
         pvFields[i]->setParentAndName(this,fieldNames[i]);
     }
 }

Member Function Documentation

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

Definition at line 329 of file PVStructure.cpp.

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

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

Definition at line 340 of file PVStructure.cpp.

 {
     if (this == &from)
         return;
 
     PVFieldPtrArray const & fromPVFields = from.getPVFields();
     PVFieldPtrArray const & toPVFields = getPVFields();
 
     size_t fieldsSize = fromPVFields.size();
     for(size_t i = 0; i<fieldsSize; i++) {
         toPVFields[i]->copyUnchecked(*fromPVFields[i]);
     }
 }

void epics::pvData::PVStructure::copyUnchecked	(	const PVStructure &	from,
		const BitSet &	maskBitSet,
		bool	inverse = `false`
	)

Definition at line 354 of file PVStructure.cpp.

 {
     if (this == &from)
         return;
 
     size_t numberFields = from.getNumberFields();
     size_t offset = from.getFieldOffset();
     int32 next = inverse ?
                 maskBitSet.nextClearBit(static_cast<uint32>(offset)) :
                 maskBitSet.nextSetBit(static_cast<uint32>(offset));
 
     // no more changes or no changes in this structure
     if(next<0||next>=static_cast<int32>(offset+numberFields)) return;
 
     // entire structure
     if(static_cast<int32>(offset)==next) {
         copyUnchecked(from);
         return;
     }
 
     PVFieldPtrArray const & fromPVFields = from.getPVFields();
     PVFieldPtrArray const & toPVFields = getPVFields();
 
     size_t fieldsSize = fromPVFields.size();
     for(size_t i = 0; i<fieldsSize; i++) {
         PVFieldPtr pvField = fromPVFields[i];
         offset = pvField->getFieldOffset();
         int32 inumberFields = static_cast<int32>(pvField->getNumberFields());
         next = inverse ?
                     maskBitSet.nextClearBit(static_cast<uint32>(offset)) :
                     maskBitSet.nextSetBit(static_cast<uint32>(offset));
 
         // no more changes
         if(next<0) return;
         //  no change in this pvField
         if(next>=static_cast<int32>(offset+inumberFields)) continue;
 
         // serialize field or fields
         if(inumberFields==1) {
             toPVFields[i]->copyUnchecked(*pvField);
         } else {
             PVStructure::shared_pointer fromPVStructure = std::tr1::static_pointer_cast<PVStructure>(pvField);
             PVStructure::shared_pointer toPVStructure = std::tr1::static_pointer_cast<PVStructure>(toPVFields[i]);
             toPVStructure->copyUnchecked(*fromPVStructure, maskBitSet, inverse);
        }
     }
 }

void epics::pvData::PVStructure::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 225 of file PVStructure.cpp.

                                          {
     size_t fieldsSize = pvFields.size();
     for(size_t i = 0; i<fieldsSize; i++)
         pvFields[i]->deserialize(pbuffer, pcontrol);
 
 }

void epics::pvData::PVStructure::deserialize	(	ByteBuffer *	pbuffer,
		DeserializableControl *	pflusher,
		BitSet *	pbitSet
	)

virtual

Deserialize

Parameters

pbuffer	The byte buffer.
pflusher	Interface to call when buffer is empty.
pbitSet	A bitset the specifies which fields to deserialize.

Implements epics::pvData::BitSetSerializable.

Definition at line 269 of file PVStructure.cpp.

                                                           {
     size_t offset = getFieldOffset();
     size_t numberFields = getNumberFields();
     int32 next = pbitSet->nextSetBit(static_cast<uint32>(offset));
 
     // no more changes or no changes in this structure
     if(next<0||next>=static_cast<int32>(offset+numberFields)) return;
 
     // entire structure
     if(static_cast<int32>(offset)==next) {
         deserialize(pbuffer, pcontrol);
         return;
     }
 
     size_t fieldsSize = pvFields.size();
     for(size_t i = 0; i<fieldsSize; i++) {
         PVFieldPtr pvField = pvFields[i];
         offset = pvField->getFieldOffset();
         int32 inumberFields = static_cast<int32>(pvField->getNumberFields());
         next = pbitSet->nextSetBit(static_cast<uint32>(offset));
         // no more changes
         if(next<0) return;
         //  no change in this pvField
         if(next>=static_cast<int32>(offset+inumberFields)) continue;
 
         // deserialize field or fields
         if(inumberFields==1) {
             pvField->deserialize(pbuffer, pcontrol);
         } else {
             PVStructurePtr pvStructure = std::tr1::static_pointer_cast<PVStructure>(pvField);
             pvStructure->deserialize(pbuffer, pcontrol, pbitSet);
         }
     }
 }

std::ostream & epics::pvData::PVStructure::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 305 of file PVStructure.cpp.

 {
     o << format::indent() << getStructure()->getID() << ' ' << getFieldName();
     o << std::endl;
     {
         format::indent_scope s(o);
 
         PVFieldPtrArray const & fieldsData = getPVFields();
         if (fieldsData.size() != 0) {
             size_t length = getStructure()->getNumberFields();
             for(size_t i=0; i<length; i++) {
                 PVFieldPtr fieldField = fieldsData[i];
                 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 PVFieldPtrArray& epics::pvData::PVStructure::getPVFields ( ) const

inline

Get the array of pointers to the subfields in the structure.

Returns: The array.

Definition at line 736 of file pvData.h.

736 { return pvFields; }

const StructureConstPtr& epics::pvData::PVStructure::getStructure ( ) const

inline

Get the introspection interface

Returns: The interface.

Definition at line 731 of file pvData.h.

731 { return structurePtr; }

template<typename A >

FORCE_INLINE std::tr1::shared_ptr<PVField> epics::pvData::PVStructure::getSubField ( A a )

inline

Get the subfield with the specified offset.

Parameters

a	A sub-field name or index

Returns: Pointer to the field or NULL if field does not exist.

Definition at line 744 of file pvData.h.

     {
         return getSubFieldImpl(a, false);
     }

template<typename A >

FORCE_INLINE std::tr1::shared_ptr<const PVField> epics::pvData::PVStructure::getSubField ( A a ) const

inline

Definition at line 750 of file pvData.h.

     {
         return getSubFieldImpl(a, false);
     }

template<typename PVD , typename A >

std::tr1::shared_ptr<PVD> epics::pvData::PVStructure::getSubField ( A a )

inline

Get a subfield with the specified name.

Parameters

a	A sub-field name or index

Returns: A pointer to the sub-field or null if field does not exist or has a different type
PVIntPtr ptr = pvStruct->getSubField<PVInt>("substruct.leaffield");

A field name is a '.' delimited list of child field names (no whitespace allowed)

Definition at line 766 of file pvData.h.

     {
         STATIC_ASSERT(PVD::isPVField); // only allow cast from PVField sub-class
         return std::tr1::dynamic_pointer_cast<PVD>(getSubFieldImpl(a, false));
     }

template<typename PVD , typename A >

std::tr1::shared_ptr<const PVD> epics::pvData::PVStructure::getSubField ( A a ) const

inline

Definition at line 773 of file pvData.h.

     {
         STATIC_ASSERT(PVD::isPVField); // only allow cast from PVField sub-class
         return std::tr1::dynamic_pointer_cast<const PVD>(getSubFieldImpl(a, false));
     }

template<typename A >

FORCE_INLINE std::tr1::shared_ptr<PVField> epics::pvData::PVStructure::getSubFieldT ( A a )

inline

Get the subfield with the specified offset.

Parameters

a	A sub-field name or index

Exceptions

std::runtime_error if the requested sub-field doesn't exist, or has a different type

Returns: Pointer to the field

Definition at line 786 of file pvData.h.

     {
         return getSubFieldImpl(a, true);
     }

template<typename A >

FORCE_INLINE std::tr1::shared_ptr<const PVField> epics::pvData::PVStructure::getSubFieldT ( A a ) const

inline

Definition at line 792 of file pvData.h.

     {
         return getSubFieldImpl(a, true);
     }

template<typename PVD , typename A >

std::tr1::shared_ptr<PVD> epics::pvData::PVStructure::getSubFieldT ( A a )

inline

Definition at line 806 of file pvData.h.

     {
         STATIC_ASSERT(PVD::isPVField); // only allow cast from PVField sub-class
         std::tr1::shared_ptr<PVD> ret(std::tr1::dynamic_pointer_cast<PVD>(getSubFieldImpl(a, true)));
         if(!ret)
             throwBadFieldType(a);
         return ret;
     }

template<typename PVD , typename A >

std::tr1::shared_ptr<const PVD> epics::pvData::PVStructure::getSubFieldT ( A a ) const

inline

Definition at line 816 of file pvData.h.

     {
         STATIC_ASSERT(PVD::isPVField); // only allow cast from PVField sub-class
         std::tr1::shared_ptr<const PVD> ret(std::tr1::dynamic_pointer_cast<const PVD>(getSubFieldImpl(a, true)));
         if(!ret)
             throwBadFieldType(a);
         return ret;
     }

epics::pvData::PVStructure::POINTER_DEFINITIONS ( PVStructure )

void epics::pvData::PVStructure::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 218 of file PVStructure.cpp.

                                              {
     size_t fieldsSize = pvFields.size();
     for(size_t i = 0; i<fieldsSize; i++)
         pvFields[i]->serialize(pbuffer, pflusher);
 }

void epics::pvData::PVStructure::serialize	(	ByteBuffer *	pbuffer,
		SerializableControl *	pflusher,
		BitSet *	pbitSet
	)		const

virtual

Serialize.

Parameters

pbuffer	The byte buffer.
pflusher	Interface to call when buffer is full.
pbitSet	A bitset the specifies which fields to serialize.

Implements epics::pvData::BitSetSerializable.

Definition at line 233 of file PVStructure.cpp.

                                                               {
     size_t numberFields = this->getNumberFields();
     size_t offset = this->getFieldOffset();
     int32 next = pbitSet->nextSetBit(static_cast<uint32>(offset));
 
     // no more changes or no changes in this structure
     if(next<0||next>=static_cast<int32>(offset+numberFields)) return;
 
     // entire structure
     if(static_cast<int32>(offset)==next) {
         serialize(pbuffer, pflusher);
         return;
     }
 
     size_t fieldsSize = pvFields.size();
     for(size_t i = 0; i<fieldsSize; i++) {
         PVField* pvField = pvFields[i].get();
         offset = pvField->getFieldOffset();
         int32 inumberFields = static_cast<int32>(pvField->getNumberFields());
         next = pbitSet->nextSetBit(static_cast<uint32>(offset));
 
         // no more changes
         if(next<0) return;
         //  no change in this pvField
         if(next>=static_cast<int32>(offset+inumberFields)) continue;
 
         // serialize field or fields
         if(inumberFields==1) {
             pvField->serialize(pbuffer, pflusher);
         } else {
             static_cast<PVStructure*>(pvField)->serialize(pbuffer, pflusher, pbitSet);
        }
     }
 }

void epics::pvData::PVStructure::setImmutable ( )

virtual

Set the field to be immutable, i.e. it can no longer be modified. This is permanent, i.e. once done the field cannot be made mutable.

Reimplemented from epics::pvData::PVField.

Definition at line 65 of file PVStructure.cpp.

 {
     size_t numFields = pvFields.size();
     for(size_t i=0; i<numFields; i++) {
         PVFieldPtr pvField  = pvFields[i];
         pvField->setImmutable();
     }
     PVField::setImmutable();
 }

FORCE_INLINE Formatter epics::pvData::PVStructure::stream ( ) const

inline

Definition at line 913 of file pvData.h.

913 { return Formatter(*this); }

Friends And Related Function Documentation

friend class PVDataCreate

friend

Definition at line 926 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/PVStructure.cpp

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation