epics::pvData::ScalarArray Class Reference

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

#include <pv/pvIntrospect.h>

Inheritance diagram for epics::pvData::ScalarArray:

Collaboration diagram for epics::pvData::ScalarArray:

Public Types
typedef std::tr1::shared_ptr< ScalarArray >	shared_pointer
typedef std::tr1::shared_ptr< const ScalarArray >	const_shared_pointer
typedef std::tr1::weak_ptr< ScalarArray >	weak_pointer
typedef std::tr1::weak_ptr< const ScalarArray >	const_weak_pointer
typedef ScalarArray &	reference
typedef const ScalarArray &	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
	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< PVScalarArray >	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 ()

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.

Member Typedef Documentation

const_reference

const ScalarArray& epics::pvData::ScalarArray::const_reference

Definition at line 493 of file pvIntrospect.h.

const_shared_pointer

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

Definition at line 491 of file pvIntrospect.h.

const_weak_pointer

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

Definition at line 491 of file pvIntrospect.h.

reference

ScalarArray& epics::pvData::ScalarArray::reference

Definition at line 492 of file pvIntrospect.h.

shared_pointer

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

Definition at line 491 of file pvIntrospect.h.

weak_pointer

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

Definition at line 491 of file pvIntrospect.h.

Constructor & Destructor Documentation

ScalarArray()

epics::pvData::ScalarArray::ScalarArray

(

ScalarType

scalarType

)

Constructor

Parameters

scalarType

The 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

buffer	serialization buffer.
flusher	deserialization 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

o	output 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::BoundedScalarArray, and epics::pvData::FixedScalarArray.

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::BoundedScalarArray, and epics::pvData::FixedScalarArray.

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::BoundedScalarArray, and epics::pvData::FixedScalarArray.

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

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

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

Friends And Related Symbol Documentation

FieldCreate

friend class FieldCreate

friend

Definition at line 525 of file pvIntrospect.h.

---

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

• pv/pvIntrospect.h