Data interface for a structure,. More...

#include <pv/pvData.h>

Inheritance diagram for epics::pvData::PVStructure:

[legend]

Collaboration diagram for epics::pvData::PVStructure:

[legend]

Classes
struct	Formatter

Public Types
typedef std::tr1::shared_ptr< PVStructure >	shared_pointer

typedef std::tr1::shared_ptr< const PVStructure >	const_shared_pointer

typedef std::tr1::weak_ptr< PVStructure >	weak_pointer

typedef std::tr1::weak_ptr< const PVStructure >	const_weak_pointer

typedef PVStructure &	reference

typedef const PVStructure &	const_reference

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

typedef std::tr1::shared_ptr< PVField >	shared_pointer

typedef std::tr1::shared_ptr< const PVField >	const_shared_pointer

typedef std::tr1::weak_ptr< PVField >	weak_pointer

typedef std::tr1::weak_ptr< const PVField >	const_weak_pointer

Public Member Functions
virtual	~PVStructure ()

virtual void	setImmutable ()

const StructureConstPtr &	getStructure () const

const PVFieldPtrArray &	getPVFields () const

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

template<typename A >
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 >
std::tr1::shared_ptr< PVField >	getSubFieldT (A a)

template<typename A >
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

virtual void	deserialize (ByteBuffer pbuffer, DeserializableControl pflusher)

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

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

	PVStructure (StructureConstPtr const &structure)

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

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

void	copy (const PVStructure &from)

void	copyUnchecked (const PVStructure &from)

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

Formatter	stream () const

Public Member Functions inherited from epics::pvData::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

◆ const_reference

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

Definition at line 721 of file pvData.h.

◆ const_shared_pointer

std::tr1::shared_ptr<const PVStructure> epics::pvData::PVStructure::const_shared_pointer

Definition at line 715 of file pvData.h.

◆ const_weak_pointer

std::tr1::weak_ptr<const PVStructure> epics::pvData::PVStructure::const_weak_pointer

Definition at line 715 of file pvData.h.

◆ reference

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

Definition at line 720 of file pvData.h.

◆ shared_pointer

std::tr1::shared_ptr<PVStructure> epics::pvData::PVStructure::shared_pointer

Definition at line 715 of file pvData.h.

◆ weak_pointer

std::tr1::weak_ptr<PVStructure> epics::pvData::PVStructure::weak_pointer

Definition at line 715 of file pvData.h.

Constructor & Destructor Documentation

◆ ~PVStructure()

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

virtual

Destructor

◆ PVStructure() [1/2]

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

explicit

Constructor

Parameters

structure The introspection interface.

◆ PVStructure() [2/2]

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

Constructor

Parameters

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

Member Function Documentation

◆ deserialize() [1/2]

virtual 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.

◆ deserialize() [2/2]

virtual 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.

◆ dumpValue()

virtual 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.

◆ getPVFields()

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.

◆ getStructure()

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

inline

Get the introspection interface

Returns: The interface.

Definition at line 731 of file pvData.h.

◆ getSubField() [1/4]

template<typename A >

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.

◆ getSubField() [2/4]

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");

epics::pvData::PVScalarValue
Class that holds the data for each possible scalar type.
Definition pvData.h:378

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

Definition at line 766 of file pvData.h.

◆ getSubField() [3/4]

template<typename A >

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

inline

Definition at line 750 of file pvData.h.

◆ getSubField() [4/4]

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.

◆ getSubFieldT() [1/4]

template<typename A >

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.

◆ getSubFieldT() [2/4]

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.

◆ getSubFieldT() [3/4]

template<typename A >

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

inline

Definition at line 792 of file pvData.h.

◆ getSubFieldT() [4/4]

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.

◆ serialize() [1/2]

virtual 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.

◆ serialize() [2/2]

virtual 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.

◆ setImmutable()

virtual 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.

◆ stream()

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

inline

Definition at line 913 of file pvData.h.

Friends And Related Symbol Documentation

◆ PVDataCreate

friend class PVDataCreate

friend

Definition at line 926 of file pvData.h.

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

pv/pvData.h

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ const_shared_pointer

◆ const_weak_pointer

◆ reference

◆ shared_pointer

◆ weak_pointer

Constructor & Destructor Documentation

◆ ~PVStructure()

◆ PVStructure() [1/2]

◆ PVStructure() [2/2]

Member Function Documentation

◆ deserialize() [1/2]

◆ deserialize() [2/2]

◆ dumpValue()

◆ getPVFields()

◆ getStructure()

◆ getSubField() [1/4]

◆ getSubField() [2/4]

◆ getSubField() [3/4]

◆ getSubField() [4/4]

◆ getSubFieldT() [1/4]

◆ getSubFieldT() [2/4]

◆ getSubFieldT() [3/4]

◆ getSubFieldT() [4/4]

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setImmutable()

◆ stream()

Friends And Related Symbol Documentation

◆ PVDataCreate