epics::pvData::ScalarArray Class Reference

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

#include "pvIntrospect.h"

Inheritance diagram for epics::pvData::ScalarArray:

Collaboration diagram for epics::pvData::ScalarArray:

Public Types
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 (ScalarArray)
	ScalarArray (ScalarType scalarType)
ScalarType	getElementType () const
virtual ArraySizeType	getArraySizeType () const OVERRIDE
virtual std::size_t	getMaximumCapacity () const OVERRIDE
virtual std::string	getID () const OVERRIDE
virtual std::ostream &	dump (std::ostream &o) const OVERRIDE FINAL
virtual void	serialize (ByteBuffer *buffer, SerializableControl *control) const OVERRIDE
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 scalar array.

Definition at line 497 of file pvIntrospect.h.

Member Typedef Documentation

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

Definition at line 501 of file pvIntrospect.h.

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

Definition at line 500 of file pvIntrospect.h.

Constructor & Destructor Documentation

epics::pvData::ScalarArray::ScalarArray

(

ScalarType

scalarType

)

Constructor

Parameters

scalarType

The scalarType for the field.

Definition at line 310 of file FieldCreateFactory.cpp.

    : Array(scalarArray),
      elementType(elementType)
{
    if(elementType<0 || elementType>MAX_SCALAR_TYPE)
        throw std::invalid_argument("Can't construct ScalarArray from invalid ScalarType");
}

epics::pvData::ScalarArray::~ScalarArray ( )

virtual

Definition at line 318 of file FieldCreateFactory.cpp.

{
    cacheCleanup();
}

Member Function Documentation

std::tr1::shared_ptr< PVScalarArray > epics::pvData::ScalarArray::build

(

)

const

Allocate a new instance

Version

Added after 7.0.0

Definition at line 361 of file FieldCreateFactory.cpp.

{
    return getPVDataCreate()->createPVScalarArray(std::tr1::static_pointer_cast<const ScalarArray>(shared_from_this()));
}

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

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 357 of file FieldCreateFactory.cpp.

                                                                     {
    throw std::runtime_error("not valid operation, use FieldCreate::deserialize instead");
}

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.

Definition at line 347 of file FieldCreateFactory.cpp.

{
    return o << format::indent() << getID();
}

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 514 of file pvIntrospect.h.

{return Array::variable;}

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

inline

Get the scalarType for the elements.

Returns

the scalarType

Definition at line 512 of file pvIntrospect.h.

{return elementType;}

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.

Definition at line 342 of file FieldCreateFactory.cpp.

{
    return getIDScalarArrayLUT();
}

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 516 of file pvIntrospect.h.

{return 0;}

epics::pvData::ScalarArray::POINTER_DEFINITIONS

(

ScalarArray

)

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

Definition at line 352 of file FieldCreateFactory.cpp.

                                                                                  {
    control->ensureBuffer(1);
    buffer->putByte((int8)0x08 | Scalar::getTypeCodeLUT(elementType));
}

Friends And Related Function Documentation

friend class FieldCreate

friend

Definition at line 533 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