epics::pvData::StructureArray Class Reference

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

#include <pv/pvIntrospect.h>

Inheritance diagram for epics::pvData::StructureArray:

Collaboration diagram for epics::pvData::StructureArray:

Public Types
typedef std::tr1::shared_ptr< StructureArray >	shared_pointer
typedef std::tr1::shared_ptr< const StructureArray >	const_shared_pointer
typedef std::tr1::weak_ptr< StructureArray >	weak_pointer
typedef std::tr1::weak_ptr< const StructureArray >	const_weak_pointer
typedef StructureArray &	reference
typedef const StructureArray &	const_reference
Public Types inherited from epics::pvData::Array
enum	ArraySizeType { variable , fixed , bounded }
typedef std::tr1::shared_ptr< Array >	shared_pointer
typedef std::tr1::shared_ptr< const Array >	const_shared_pointer
typedef std::tr1::weak_ptr< Array >	weak_pointer
typedef std::tr1::weak_ptr< const Array >	const_weak_pointer
typedef Array &	reference
typedef const Array &	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
const StructureConstPtr &	getStructure () const
virtual ArraySizeType	getArraySizeType () const
virtual std::size_t	getMaximumCapacity () 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< PVValueArray< std::tr1::shared_ptr< PVStructure > > >	build () const
Public Member Functions inherited from epics::pvData::Array
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 ()

Protected Member Functions
	StructureArray (StructureConstPtr const &structure)
Protected Member Functions inherited from epics::pvData::Array
	Array (Type type)
Protected Member Functions inherited from epics::pvData::Field
	Field (Type type)
void	cacheCleanup ()

Friends
class	FieldCreate

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

Detailed Description

This class implements introspection object for a structureArray.

Definition at line 599 of file pvIntrospect.h.

Member Typedef Documentation

const_reference

const StructureArray& epics::pvData::StructureArray::const_reference

Definition at line 603 of file pvIntrospect.h.

const_shared_pointer

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

Definition at line 601 of file pvIntrospect.h.

const_weak_pointer

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

Definition at line 601 of file pvIntrospect.h.

reference

StructureArray& epics::pvData::StructureArray::reference

Definition at line 602 of file pvIntrospect.h.

shared_pointer

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

Definition at line 601 of file pvIntrospect.h.

weak_pointer

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

Definition at line 601 of file pvIntrospect.h.

Constructor & Destructor Documentation

StructureArray()

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

protected

Constructor.

Parameters

structure

The introspection interface for the elements.

Member Function Documentation

build()

std::tr1::shared_ptr< PVValueArray< std::tr1::shared_ptr< PVStructure > > > epics::pvData::StructureArray::build

(

)

const

Allocate a new instance

Version

Added after 7.0.0

deserialize()

virtual void epics::pvData::StructureArray::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::StructureArray::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.

getArraySizeType()

virtual ArraySizeType epics::pvData::StructureArray::getArraySizeType ( ) const

inlinevirtual

Get array size type (i.e. variable/fixed/bounded size array).

Returns

array size type enum.

Implements epics::pvData::Array.

Definition at line 611 of file pvIntrospect.h.

getID()

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

virtual

Get the identification string.

Returns

The identification string, can be empty.

Implements epics::pvData::Field.

getMaximumCapacity()

virtual std::size_t epics::pvData::StructureArray::getMaximumCapacity ( ) const

inlinevirtual

Get maximum capacity of the array.

Returns

maximum capacity of the array, 0 indicates variable size array.

Implements epics::pvData::Array.

Definition at line 613 of file pvIntrospect.h.

getStructure()

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

inline

Get the introspection interface for the array elements.

Returns

The introspection interface.

Definition at line 609 of file pvIntrospect.h.

serialize()

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

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

Friends And Related Symbol Documentation

FieldCreate

friend class FieldCreate

friend

Definition at line 636 of file pvIntrospect.h.

---

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

• pv/pvIntrospect.h