epics::pvData::FixedScalarArray Class Reference

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

#include "pvIntrospect.h"

Inheritance diagram for epics::pvData::FixedScalarArray:

Collaboration diagram for epics::pvData::FixedScalarArray:

Public Types
typedef FixedScalarArray &	reference
typedef const FixedScalarArray &	const_reference
Public Types inherited from epics::pvData::ScalarArray
typedef ScalarArray &	reference
typedef const ScalarArray &	const_reference
Public Types inherited from epics::pvData::Array
enum	ArraySizeType { variable, fixed, bounded }
typedef Array &	reference
typedef const Array &	const_reference
Public Types inherited from epics::pvData::Field
enum	{ isField =1 }

Public Member Functions
	POINTER_DEFINITIONS (FixedScalarArray)
	FixedScalarArray (ScalarType scalarType, std::size_t size)
virtual ArraySizeType	getArraySizeType () const OVERRIDE FINAL
virtual std::size_t	getMaximumCapacity () const OVERRIDE FINAL
virtual std::string	getID () const OVERRIDE FINAL
virtual void	serialize (ByteBuffer *buffer, SerializableControl *control) const OVERRIDE FINAL
virtual	~FixedScalarArray ()
Public Member Functions inherited from epics::pvData::ScalarArray
	POINTER_DEFINITIONS (ScalarArray)
	ScalarArray (ScalarType scalarType)
ScalarType	getElementType () const
virtual std::ostream &	dump (std::ostream &o) const OVERRIDE FINAL
virtual void	deserialize (ByteBuffer *buffer, DeserializableControl *control) OVERRIDE FINAL
std::tr1::shared_ptr< PVScalarArray >	build () const
virtual	~ScalarArray ()
Public Member Functions inherited from epics::pvData::Array
	POINTER_DEFINITIONS (Array)
virtual	~Array ()
Public Member Functions inherited from epics::pvData::Field
	POINTER_DEFINITIONS (Field)
virtual	~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 bounded scalar array.

Definition at line 575 of file pvIntrospect.h.

Member Typedef Documentation

typedef const FixedScalarArray& epics::pvData::FixedScalarArray::const_reference

Definition at line 579 of file pvIntrospect.h.

typedef FixedScalarArray& epics::pvData::FixedScalarArray::reference

Definition at line 578 of file pvIntrospect.h.

Constructor & Destructor Documentation

epics::pvData::FixedScalarArray::FixedScalarArray	(	ScalarType	scalarType,
		std::size_t	size
	)

Constructor

Parameters

scalarType	The scalarType for the field.
size	maximum (bound) capacity.

Definition at line 397 of file FieldCreateFactory.cpp.

    : ScalarArray(elementType),
      size(size)
{
}

epics::pvData::FixedScalarArray::~FixedScalarArray ( )

virtual

Definition at line 392 of file FieldCreateFactory.cpp.

{
    cacheCleanup();
}

Member Function Documentation

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

inlinevirtual

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

Returns

array size type enum.

Reimplemented from epics::pvData::ScalarArray.

Definition at line 588 of file pvIntrospect.h.

{return Array::fixed;}

string epics::pvData::FixedScalarArray::getID ( ) const

virtual

Get the identification string.

Returns

The identification string, can be empty.

Reimplemented from epics::pvData::ScalarArray.

Definition at line 403 of file FieldCreateFactory.cpp.

{
    char buffer[32];
    sprintf(buffer, "%s[%zu]", ScalarTypeFunc::name(getElementType()), size);
    return string(buffer);
}

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

inlinevirtual

Get maximum capacity of the array.

Returns

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

Reimplemented from epics::pvData::ScalarArray.

Definition at line 590 of file pvIntrospect.h.

{return size;}

epics::pvData::FixedScalarArray::POINTER_DEFINITIONS

(

FixedScalarArray

)

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

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Reimplemented from epics::pvData::ScalarArray.

Definition at line 410 of file FieldCreateFactory.cpp.

                                                                                       {
    control->ensureBuffer(1);
    buffer->putByte((int8)0x18 | Scalar::getTypeCodeLUT(getElementType()));
    SerializeHelper::writeSize(size, buffer, control);
}

Friends And Related Function Documentation

friend class FieldCreate

friend

Definition at line 599 of file pvIntrospect.h.

---

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

• modules/pvData/src/pv/pvIntrospect.h
• modules/pvData/src/factory/FieldCreateFactory.cpp