PVData C++  8.0.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
epics::pvData::StructureArray Class Reference

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

#include <pv/pvIntrospect.h>

Inheritance diagram for epics::pvData::StructureArray:
Inheritance graph
[legend]
Collaboration diagram for epics::pvData::StructureArray:
Collaboration graph
[legend]

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 StructureArrayreference
 
typedef const StructureArrayconst_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< Arrayweak_pointer
 
typedef std::tr1::weak_ptr
< const Array
const_weak_pointer
 
typedef Arrayreference
 
typedef const Arrayconst_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< Fieldweak_pointer
 
typedef std::tr1::weak_ptr
< const Field
const_weak_pointer
 

Public Member Functions

const StructureConstPtrgetStructure () const
 
virtual ArraySizeType getArraySizeType () const
 
virtual std::size_t getMaximumCapacity () const
 
virtual std::string getID () const
 
virtual std::ostreamdump (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::Field
Type getType () const
 
std::tr1::shared_ptr< PVFieldbuild () 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.

Constructor & Destructor Documentation

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

Constructor.

Parameters
structureThe introspection interface for the elements.

Member Function Documentation

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
virtual void epics::pvData::StructureArray::deserialize ( ByteBuffer buffer,
DeserializableControl flusher 
)
virtual

Deserialize buffer.

Parameters
bufferserialization buffer.
flusherdeserialization control.

Implements epics::pvData::Serializable.

virtual std::ostream& epics::pvData::StructureArray::dump ( std::ostream o) const
virtual

Puts the string representation to the stream.

Parameters
ooutput stream.
Returns
The output stream.

Implements epics::pvData::Field.

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.

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

Get the identification string.

Returns
The identification string, can be empty.

Implements epics::pvData::Field.

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.

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.

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

Serialize field into given buffer.

Parameters
bufferserialization buffer.
flusherflush interface.

Implements epics::pvData::Serializable.


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