This is Unofficial EPICS BASE Doxygen Site
epics::pvData::Array Class Referenceabstract

This class implements introspection object for Array. More...

#include "pvIntrospect.h"

+ Inheritance diagram for epics::pvData::Array:
+ Collaboration diagram for epics::pvData::Array:

Public Types

enum  ArraySizeType { variable, fixed, bounded }
 
typedef Arrayreference
 
typedef const Arrayconst_reference
 
- Public Types inherited from epics::pvData::Field
enum  { isField =1 }
 

Public Member Functions

 POINTER_DEFINITIONS (Array)
 
virtual ~Array ()
 
virtual ArraySizeType getArraySizeType () const =0
 
virtual std::size_t getMaximumCapacity () const =0
 
- Public Member Functions inherited from epics::pvData::Field
 POINTER_DEFINITIONS (Field)
 
virtual ~Field ()
 
Type getType () const
 
virtual std::string getID () const =0
 
virtual std::ostream & dump (std::ostream &o) const =0
 
std::tr1::shared_ptr< PVFieldbuild () const
 
- Public Member Functions inherited from epics::pvData::Serializable
virtual ~Serializable ()
 
virtual void serialize (ByteBuffer *buffer, SerializableControl *flusher) const =0
 
virtual void deserialize (ByteBuffer *buffer, DeserializableControl *flusher)=0
 

Protected Member Functions

 Array (Type type)
 
- Protected Member Functions inherited from epics::pvData::Field
 Field (Type type)
 
void cacheCleanup ()
 

Additional Inherited Members

- Static Public Attributes inherited from epics::pvData::Field
static size_t num_instances
 

Detailed Description

This class implements introspection object for Array.

Definition at line 462 of file pvIntrospect.h.

Member Typedef Documentation

Definition at line 467 of file pvIntrospect.h.

Definition at line 466 of file pvIntrospect.h.

Member Enumeration Documentation

Constructor & Destructor Documentation

epics::pvData::Array::~Array ( )
virtual

Definition at line 308 of file FieldCreateFactory.cpp.

308 {}
epics::pvData::Array::Array ( Type  type)
protected

Constructor

Parameters
typeThe field type.

Definition at line 303 of file FieldCreateFactory.cpp.

304  : Field(type)
305 {
306 }
pvd::StructureConstPtr type

Member Function Documentation

virtual ArraySizeType epics::pvData::Array::getArraySizeType ( ) const
pure virtual

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

Returns
array size type enum.

Implemented in epics::pvData::UnionArray, epics::pvData::StructureArray, epics::pvData::FixedScalarArray, epics::pvData::BoundedScalarArray, and epics::pvData::ScalarArray.

virtual std::size_t epics::pvData::Array::getMaximumCapacity ( ) const
pure virtual

Get maximum capacity of the array.

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

Implemented in epics::pvData::UnionArray, epics::pvData::StructureArray, epics::pvData::FixedScalarArray, epics::pvData::BoundedScalarArray, and epics::pvData::ScalarArray.

epics::pvData::Array::POINTER_DEFINITIONS ( Array  )

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