PVData C++  8.0.5
Public Types | Public Member Functions | Friends | List of all members
epics::pvData::ScalarArray Class Reference

This class implements introspection object for scalar array. More...

#include <pv/pvIntrospect.h>

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

Public Types

typedef std::tr1::shared_ptr< ScalarArrayshared_pointer
 
typedef std::tr1::shared_ptr< const ScalarArrayconst_shared_pointer
 
typedef std::tr1::weak_ptr< ScalarArrayweak_pointer
 
typedef std::tr1::weak_ptr< const ScalarArrayconst_weak_pointer
 
typedef ScalarArrayreference
 
typedef const ScalarArrayconst_reference
 
- Public Types inherited from epics::pvData::Array
enum  ArraySizeType { variable, fixed, bounded }
 
typedef std::tr1::shared_ptr< Arrayshared_pointer
 
typedef std::tr1::shared_ptr< const Arrayconst_shared_pointer
 
typedef std::tr1::weak_ptr< Arrayweak_pointer
 
typedef std::tr1::weak_ptr< const Arrayconst_weak_pointer
 
typedef Arrayreference
 
typedef const Arrayconst_reference
 
- Public Types inherited from epics::pvData::Field
enum  { isField =1 }
 
typedef std::tr1::shared_ptr< Fieldshared_pointer
 
typedef std::tr1::shared_ptr< const Fieldconst_shared_pointer
 
typedef std::tr1::weak_ptr< Fieldweak_pointer
 
typedef std::tr1::weak_ptr< const Fieldconst_weak_pointer
 

Public Member Functions

 ScalarArray (ScalarType scalarType)
 
ScalarType getElementType () 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< PVScalarArraybuild () 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 ()
 

Friends

class FieldCreate
 

Additional Inherited Members

- Static Public Attributes inherited from epics::pvData::Field
static size_t num_instances
 
- Protected Member Functions inherited from epics::pvData::Array
 Array (Type type)
 
- Protected Member Functions inherited from epics::pvData::Field
 Field (Type type)
 
void cacheCleanup ()
 

Detailed Description

This class implements introspection object for scalar array.

Definition at line 489 of file pvIntrospect.h.

Constructor & Destructor Documentation

◆ ScalarArray()

epics::pvData::ScalarArray::ScalarArray ( ScalarType  scalarType)

Constructor

Parameters
scalarTypeThe scalarType for the field.

Member Function Documentation

◆ build()

std::tr1::shared_ptr<PVScalarArray> epics::pvData::ScalarArray::build ( ) const

Allocate a new instance

Version
Added after 7.0.0

◆ deserialize()

virtual void epics::pvData::ScalarArray::deserialize ( ByteBuffer buffer,
DeserializableControl flusher 
)
virtual

Deserialize buffer.

Parameters
bufferserialization buffer.
flusherdeserialization control.

Implements epics::pvData::Serializable.

◆ dump()

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

Puts the string representation to the stream.

Parameters
ooutput stream.
Returns
The output stream.

Implements epics::pvData::Field.

◆ getArraySizeType()

virtual ArraySizeType epics::pvData::ScalarArray::getArraySizeType ( ) const
inlinevirtual

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

Returns
array size type enum.

Implements epics::pvData::Array.

Reimplemented in epics::pvData::FixedScalarArray, and epics::pvData::BoundedScalarArray.

Definition at line 506 of file pvIntrospect.h.

◆ getElementType()

ScalarType epics::pvData::ScalarArray::getElementType ( ) const
inline

Get the scalarType for the elements.

Returns
the scalarType

Definition at line 504 of file pvIntrospect.h.

◆ getID()

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

Get the identification string.

Returns
The identification string, can be empty.

Implements epics::pvData::Field.

Reimplemented in epics::pvData::FixedScalarArray, and epics::pvData::BoundedScalarArray.

◆ getMaximumCapacity()

virtual std::size_t epics::pvData::ScalarArray::getMaximumCapacity ( ) const
inlinevirtual

Get maximum capacity of the array.

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

Implements epics::pvData::Array.

Reimplemented in epics::pvData::FixedScalarArray, and epics::pvData::BoundedScalarArray.

Definition at line 508 of file pvIntrospect.h.

◆ serialize()

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

Serialize field into given buffer.

Parameters
bufferserialization buffer.
flusherflush interface.

Implements epics::pvData::Serializable.

Reimplemented in epics::pvData::FixedScalarArray, and epics::pvData::BoundedScalarArray.


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