Data class for a structureArray. More...

#include "pvData.h"

Inheritance diagram for epics::pvData::PVValueArray< PVStructurePtr >:

Collaboration diagram for epics::pvData::PVValueArray< PVStructurePtr >:

Public Types
typedef PVStructurePtr	value_type

typedef PVStructurePtr *	pointer

typedef const PVStructurePtr *	const_pointer

typedef PVStructureArray &	reference

typedef const PVStructureArray &	const_reference

typedef ::epics::pvData::shared_vector< PVStructurePtr >	svector

typedef ::epics::pvData::shared_vector< const PVStructurePtr >	const_svector

Public Types inherited from epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >
typedef PVStructurePtr	value_type

typedef PVStructurePtr *	pointer

typedef const PVStructurePtr *	const_pointer

typedef ::epics::pvData::shared_vector< PVStructurePtr >	svector

typedef ::epics::pvData::shared_vector< const PVStructurePtr >	const_svector

Public Types inherited from epics::pvData::PVField
enum	{ isPVField =1 }

Public Member Functions
	POINTER_DEFINITIONS (PVStructureArray)

virtual	~PVValueArray ()

virtual ArrayConstPtr	getArray () const OVERRIDE FINAL

virtual size_t	getLength () const OVERRIDE FINAL

virtual size_t	getCapacity () const OVERRIDE FINAL

virtual void	setCapacity (size_t capacity) OVERRIDE FINAL

virtual void	setLength (std::size_t length) OVERRIDE FINAL

StructureArrayConstPtr	getStructureArray () const

std::size_t	append (std::size_t number)

bool	remove (std::size_t offset, std::size_t number)

void	compress ()

virtual const_svector	view () const OVERRIDE FINAL
	Fetch a read-only view of the current array data. More...

virtual void	swap (const_svector &other) OVERRIDE FINAL

virtual void	replace (const const_svector &other) OVERRIDE FINAL

virtual void	serialize (ByteBuffer pbuffer, SerializableControl pflusher) const OVERRIDE FINAL

virtual void	deserialize (ByteBuffer buffer, DeserializableControl pflusher) OVERRIDE FINAL

virtual void	serialize (ByteBuffer pbuffer, SerializableControl pflusher, std::size_t offset, std::size_t count) const OVERRIDE FINAL

virtual std::ostream &	dumpValue (std::ostream &o) const OVERRIDE FINAL

virtual std::ostream &	dumpValue (std::ostream &o, std::size_t index) const OVERRIDE FINAL

void	copy (const PVStructureArray &from)

void	copyUnchecked (const PVStructureArray &from)

Public Member Functions inherited from epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >
virtual	~PVVectorStorage ()

svector	reuse ()

Public Member Functions inherited from epics::pvData::PVArray
	POINTER_DEFINITIONS (PVArray)

virtual	~PVArray ()

virtual void	setImmutable () OVERRIDE

bool	isCapacityMutable () const

void	setCapacityMutable (bool isMutable)

virtual void	setCapacity (std::size_t capacity)=0

Public Member Functions inherited from epics::pvData::PVField
	POINTER_DEFINITIONS (PVField)

virtual	~PVField ()

const std::string &	getFieldName () const

std::string	getFullName () const

std::size_t	getFieldOffset () const

std::size_t	getNextFieldOffset () const

std::size_t	getNumberFields () const

bool	isImmutable () const

const FieldConstPtr &	getField () const

PVStructure *	getParent ()

const PVStructure *	getParent () const

void	postPut ()

void	setPostHandler (PostHandlerPtr const &postHandler)

virtual bool	equals (PVField &pv)

void	copy (const PVField &from)

void	copyUnchecked (const PVField &from)

Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()

Public Member Functions inherited from epics::pvData::SerializableArray
virtual	~SerializableArray ()

Protected Member Functions
	PVValueArray (StructureArrayConstPtr const &structureArray)

Protected Member Functions inherited from epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >
	PVVectorStorage (A a)

Protected Member Functions inherited from epics::pvData::PVArray
	PVArray (FieldConstPtr const &field)

void	checkLength (size_t length) const

Protected Member Functions inherited from epics::pvData::PVField
PVField::shared_pointer	getPtrSelf ()

	PVField (FieldConstPtr field)

void	setParentAndName (PVStructure *parent, std::string const &fieldName)

Friends
class	PVDataCreate

Additional Inherited Members
Static Public Attributes inherited from epics::pvData::PVField
static size_t	num_instances

Detailed Description

template<>
class epics::pvData::PVValueArray< PVStructurePtr >

Data class for a structureArray.

Definition at line 1236 of file pvData.h.

Member Typedef Documentation

typedef const PVStructurePtr* epics::pvData::PVValueArray< PVStructurePtr >::const_pointer

Definition at line 1243 of file pvData.h.

typedef const PVStructureArray& epics::pvData::PVValueArray< PVStructurePtr >::const_reference

Definition at line 1245 of file pvData.h.

typedef ::epics::pvData::shared_vector<const PVStructurePtr> epics::pvData::PVValueArray< PVStructurePtr >::const_svector

Definition at line 1249 of file pvData.h.

typedef PVStructurePtr* epics::pvData::PVValueArray< PVStructurePtr >::pointer

Definition at line 1242 of file pvData.h.

typedef PVStructureArray& epics::pvData::PVValueArray< PVStructurePtr >::reference

Definition at line 1244 of file pvData.h.

typedef ::epics::pvData::shared_vector<PVStructurePtr> epics::pvData::PVValueArray< PVStructurePtr >::svector

Definition at line 1248 of file pvData.h.

typedef PVStructurePtr epics::pvData::PVValueArray< PVStructurePtr >::value_type

Definition at line 1241 of file pvData.h.

Constructor & Destructor Documentation

virtual epics::pvData::PVValueArray< PVStructurePtr >::~PVValueArray ( )

inlinevirtual

Destructor

Definition at line 1253 of file pvData.h.

1253 {}

epics::pvData::PVValueArray< PVStructurePtr >::PVValueArray ( StructureArrayConstPtr const & structureArray )

protected

Definition at line 197 of file PVDataCreateFactory.cpp.

     :base_t(structureArray)
     ,structureArray(structureArray)
 
 {}

Member Function Documentation

std::size_t epics::pvData::PVValueArray< PVStructurePtr >::append ( std::size_t number )

Append new elements to the end of the array.

Parameters

number The number of elements to add.

Returns: the new length of the array.

void epics::pvData::PVStructureArray::compress ( )

Compress. This removes all null elements from the array.

Definition at line 69 of file PVStructureArray.cpp.

                                 {
     if (getArray()->getArraySizeType() == Array::fixed)
             return;
 
     svector vec(reuse()); // TODO: check for first NULL before realloc
 
     size_t length = vec.size();
     size_t newLength = 0;
 
     for(size_t i=0; i<length; i++) {
         if(vec[i]) {
             newLength++;
             continue;
         }
         // find first non 0
         size_t notNull = 0;
         for(size_t j=i+1;j<length;j++) {
             if(vec[j]) {
                 notNull = j;
                 break;
             }
         }
         if(notNull!=0) {
             vec[i] = vec[notNull];
             vec[notNull].reset();
             newLength++;
             continue;
          }
          break;
     }
 
     vec.resize(newLength);
     const_svector cdata(freeze(vec));
     swap(cdata);
 }

void epics::pvData::PVStructureArray::copy ( const PVStructureArray & from )

Definition at line 243 of file PVStructureArray.cpp.

 {
     if(isImmutable())
         throw std::invalid_argument("destination is immutable");
 
     if(*getStructureArray() != *from.getStructureArray())
         throw std::invalid_argument("structureArray definitions do not match");
 
     copyUnchecked(from);
 }

void epics::pvData::PVStructureArray::copyUnchecked ( const PVStructureArray & from )

Definition at line 254 of file PVStructureArray.cpp.

 {
     if (this == &from)
         return;
 
     replace(from.view());
 }

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

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 159 of file PVStructureArray.cpp.

                                          {
     svector data(reuse());
 
     size_t size = this->getArray()->getArraySizeType() == Array::fixed ?
                 this->getArray()->getMaximumCapacity() :
                 SerializeHelper::readSize(pbuffer, pcontrol);
 
     data.resize(size);
 
     StructureConstPtr structure = structureArray->getStructure();
 
     PVDataCreatePtr pvDataCreate = getPVDataCreate();
 
     for(size_t i = 0; i<size; i++) {
         pcontrol->ensureData(1);
         size_t temp = pbuffer->getByte();
         if(temp==0) {
             data[i].reset();
         }
         else {
             if(data[i].get()==NULL || !data[i].unique()) {
                 data[i] = pvDataCreate->createPVStructure(structure);
             }
             data[i]->deserialize(pbuffer, pcontrol);
         }
     }
     replace(freeze(data)); // calls postPut()
 }

std::ostream & epics::pvData::PVStructureArray::dumpValue ( std::ostream & o ) const

virtual

Puts the PVField raw value to the stream.

Parameters

o	output stream.

Returns: The output stream.

Implements epics::pvData::PVField.

Definition at line 215 of file PVStructureArray.cpp.

 {
     o << format::indent() << getStructureArray()->getID() << ' ' << getFieldName() << std::endl;
     size_t length = getLength();
     if (length > 0)
     {
         format::indent_scope s(o);
 
         for (size_t i = 0; i < length; i++)
             dumpValue(o, i);
     }
 
     return o;
 }

std::ostream & epics::pvData::PVStructureArray::dumpValue	(	std::ostream &	o,
		std::size_t	index
	)		const

virtual

Implements epics::pvData::PVArray.

Definition at line 230 of file PVStructureArray.cpp.

 {
     const_svector temp(view());
     if (index<temp.size())
     {
         if (temp[index])
             o << *temp[index];
         else
             o << format::indent() << "(none)" << std::endl;
     }
     return o;
 }

virtual ArrayConstPtr epics::pvData::PVValueArray< PVStructurePtr >::getArray ( ) const

inlinevirtual

Get the introspection interface

Returns: The interface.

Implements epics::pvData::PVArray.

Definition at line 1255 of file pvData.h.

     {
         return std::tr1::static_pointer_cast<const Array>(structureArray);
     }

virtual size_t epics::pvData::PVValueArray< PVStructurePtr >::getCapacity ( ) const

inlinevirtual

Get the array capacity.

Returns: The capacity.

Implements epics::pvData::PVArray.

Definition at line 1261 of file pvData.h.

1261 {return value.capacity();}

value

Definition: link.h:174

virtual size_t epics::pvData::PVValueArray< PVStructurePtr >::getLength ( ) const

inlinevirtual

Get the array length.

Returns: The length.

Implements epics::pvData::PVArray.

Definition at line 1260 of file pvData.h.

1260 {return value.size();}

value

Definition: link.h:174

StructureArrayConstPtr epics::pvData::PVValueArray< PVStructurePtr >::getStructureArray ( ) const

inline

Get the introspection interface

Returns: The interface.

Definition at line 1278 of file pvData.h.

1278 {return structureArray;}

epics::pvData::structureArray

Definition: pvIntrospect.h:199

epics::pvData::PVValueArray< PVStructurePtr >::POINTER_DEFINITIONS ( PVStructureArray )

bool epics::pvData::PVValueArray< PVStructurePtr >::remove	(	std::size_t	offset,
		std::size_t	number
	)

Remove elements from the array.

Parameters

offset	The offset of the first element to remove.
number	The number of elements to remove.

Returns: (false,true) if the elements were removed.

virtual void epics::pvData::PVValueArray< PVStructurePtr >::replace ( const const_svector & next )

inlinevirtual

Discard current contents and replaced with the provided. Fails for Immutable arrays calls postPut()

Implements epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >.

Definition at line 1299 of file pvData.h.

                                                                     {
         checkLength(other.size());
         value = other;
         PVField::postPut();
     }

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

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

Definition at line 154 of file PVStructureArray.cpp.

                                              {
     serialize(pbuffer, pflusher, 0, getLength());
 }

virtual void epics::pvData::PVValueArray< PVStructurePtr >::serialize	(	ByteBuffer *	buffer,
		SerializableControl *	flusher,
		std::size_t	offset,
		std::size_t	count
	)		const

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.
offset	offset in elements.
count	number of elements

Implements epics::pvData::SerializableArray.

void epics::pvData::PVStructureArray::setCapacity ( size_t capacity )

virtual

Set the array capacity.

Parameters

capacity The length.

Definition at line 105 of file PVStructureArray.cpp.

 {
     if (this->isCapacityMutable()) {
         checkLength(capacity);
         const_svector value;
         swap(value);
         if(value.capacity()<capacity) {
             svector mvalue(thaw(value));
             mvalue.reserve(capacity);
             value = freeze(mvalue);
         }
         swap(value);
     }
     else
         THROW_EXCEPTION2(std::logic_error, "capacity immutable");
 }

virtual void epics::pvData::PVValueArray< PVStructurePtr >::setLength ( std::size_t length )

virtual

Set the array length.

Parameters

length The length.

Implements epics::pvData::PVArray.

void epics::pvData::PVStructureArray::swap ( const_svector & other )

virtual

Exchange our contents for the provided.

Exceptions

std::logic_error for Immutable arrays.

Callers must ensure that postPut() is called after the last swap() operation.

Before you call this directly, consider using the reuse(), or replace() methods.

Implements epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >.

Definition at line 144 of file PVStructureArray.cpp.

 {
     if (this->isImmutable())
         THROW_EXCEPTION2(std::logic_error, "immutable");
 
     // no checkLength call here
 
     value.swap(other);
 }

virtual const_svector epics::pvData::PVValueArray< PVStructurePtr >::view ( ) const

inlinevirtual

Fetch a read-only view of the current array data.

Implements epics::pvData::detail::PVVectorStorage< PVStructurePtr, PVArray >.

Definition at line 1297 of file pvData.h.

1297 { return value; }

value

Definition: link.h:174

Friends And Related Function Documentation

friend class PVDataCreate

friend

Definition at line 1323 of file pvData.h.

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

modules/pvData/src/pv/pvData.h
modules/pvData/src/factory/PVDataCreateFactory.cpp
modules/pvData/src/factory/PVStructureArray.cpp

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

template<> class epics::pvData::PVValueArray< PVStructurePtr >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<>
class epics::pvData::PVValueArray< PVStructurePtr >