template class for all extensions of PVArray. More...

#include "pvData.h"

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

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

Public Types
typedef T	value_type

typedef T *	pointer

typedef const T *	const_pointer

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

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

Public Types inherited from epics::pvData::detail::PVVectorStorage< T, PVScalarArray >
typedef T	value_type

typedef T *	pointer

typedef const T *	const_pointer

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

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

Public Types inherited from epics::pvData::PVScalarArray
typedef PVScalarArray &	reference

typedef const PVScalarArray &	const_reference

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

Public Member Functions
	POINTER_DEFINITIONS (PVValueArray)

virtual	~PVValueArray ()

virtual ArrayConstPtr	getArray () const OVERRIDE FINAL

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

virtual std::ostream &	dumpValue (std::ostream &o, size_t index) 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 (size_t length) OVERRIDE FINAL

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 &next) OVERRIDE FINAL

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

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

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

template<>
std::ostream &	dumpValue (std::ostream &o, size_t index) const

template<>
std::ostream &	dumpValue (std::ostream &o) const

template<>
void	deserialize (ByteBuffer pbuffer, DeserializableControl pcontrol)

template<>
void	serialize (ByteBuffer pbuffer, SerializableControl pflusher, size_t offset, size_t count) const

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

svector	reuse ()

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

virtual	~PVScalarArray ()

const ScalarArrayConstPtr	getScalarArray () const

template<typename T >
void	getAs (shared_vector< const T > &out) const

template<typename T >
void	putFrom (const shared_vector< const T > &inp)

void	assign (const PVScalarArray &pv)

void	copy (const PVScalarArray &from)

void	copyUnchecked (const PVScalarArray &from)

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

virtual	~PVArray ()

virtual void	setImmutable () OVERRIDE

virtual void	setLength (std::size_t length)=0

bool	isCapacityMutable () const

void	setCapacityMutable (bool isMutable)

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

virtual std::ostream &	dumpValue (std::ostream &o, std::size_t index) const =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 ()

virtual void	serialize (ByteBuffer buffer, SerializableControl flusher, std::size_t offset, std::size_t count) const =0

Static Public Attributes
static const ScalarType	typeCode = pvBoolean

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

Protected Member Functions
virtual void	_getAsVoid (epics::pvData::shared_vector< const void > &out) const OVERRIDE FINAL

virtual void	_putFromVoid (const epics::pvData::shared_vector< const void > &in) OVERRIDE FINAL

	PVValueArray (ScalarArrayConstPtr const &scalar)

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

Protected Member Functions inherited from epics::pvData::PVScalarArray
	PVScalarArray (ScalarArrayConstPtr const &scalarArray)

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)

Protected Attributes
const_svector	value

Friends
class	PVDataCreate

Detailed Description

template<typename T>
class epics::pvData::PVValueArray< T >

template class for all extensions of PVArray.

The direct extensions are pvBooleanArray, pvByteArray, ..., pvStringArray. There are specializations for PVStringArray, PVStructureArray, and PVUnionArray.

Definition at line 55 of file pvData.h.

Member Typedef Documentation

template<typename T>

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

Definition at line 1181 of file pvData.h.

template<typename T>

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

Definition at line 1185 of file pvData.h.

template<typename T>

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

Definition at line 1180 of file pvData.h.

template<typename T>

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

Definition at line 1184 of file pvData.h.

template<typename T>

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

Definition at line 1179 of file pvData.h.

Constructor & Destructor Documentation

template<typename T >

epics::pvData::PVValueArray< T >::~PVValueArray ( )

virtual

Destructor

Definition at line 209 of file PVDataCreateFactory.cpp.

209 {}

template<typename T >

epics::pvData::PVValueArray< T >::PVValueArray ( ScalarArrayConstPtr const & scalar )

explicitprotected

Definition at line 191 of file PVDataCreateFactory.cpp.

     :base_t(scalarArray)
     ,value()
 
 {}

Member Function Documentation

template<typename T >

void epics::pvData::PVValueArray< T >::_getAsVoid ( epics::pvData::shared_vector< const void > & out ) const

protectedvirtual

Implements epics::pvData::PVScalarArray.

Definition at line 454 of file PVDataCreateFactory.cpp.

 {
     out = static_shared_vector_cast<const void>(this->view());
 }

template<typename T >

void epics::pvData::PVValueArray< T >::_putFromVoid ( const epics::pvData::shared_vector< const void > & in )

protectedvirtual

Implements epics::pvData::PVScalarArray.

Definition at line 460 of file PVDataCreateFactory.cpp.

 {
     this->replace(shared_vector_convert<const T>(in));
 }

template<>

void epics::pvData::PVValueArray< string >::deserialize	(	ByteBuffer *	buffer,
		DeserializableControl *	flusher
	)

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 410 of file PVDataCreateFactory.cpp.

                                          {
 
     size_t size = this->getArray()->getArraySizeType() == Array::fixed ?
                 this->getArray()->getMaximumCapacity() :
                 SerializeHelper::readSize(pbuffer, pcontrol);
 
     svector nextvalue(thaw(value));
 
     // Decide if we must re-allocate
     if(size > nextvalue.size() || !nextvalue.unique())
         nextvalue.resize(size);
     else if(size < nextvalue.size())
         nextvalue.slice(0, size);
 
 
     string * pvalue = nextvalue.data();
     for(size_t i = 0; i<size; i++) {
         pvalue[i] = SerializeHelper::deserializeString(pbuffer,
                                                        pcontrol);
     }
     value = freeze(nextvalue);
     // inform about the change?
     postPut();
 }

template<typename T >

void epics::pvData::PVValueArray< T >::deserialize	(	ByteBuffer *	buffer,
		DeserializableControl *	flusher
	)

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

Definition at line 317 of file PVDataCreateFactory.cpp.

                                          {
 
     size_t size = this->getArray()->getArraySizeType() == Array::fixed ?
                 this->getArray()->getMaximumCapacity() :
                 SerializeHelper::readSize(pbuffer, pcontrol);
 
     svector nextvalue(thaw(value));
     nextvalue.resize(size); // TODO: avoid copy of stuff we will then overwrite
 
     T* cur = nextvalue.data();
 
     // try to avoid deserializing from the buffer
     // this is only possible if we do not need to do endian-swapping
     if (!pbuffer->reverse<T>())
         if (pcontrol->directDeserialize(pbuffer, (char*)cur, size, sizeof(T)))
         {
         // inform about the change?
         PVField::postPut();
         return;
     }
 
     // retrieve value from the buffer
     size_t remaining = size;
     while(remaining) {
         const size_t have_bytes = pbuffer->getRemaining();
 
         // correctly rounds down in an element is partially received
         const size_t available = have_bytes/sizeof(T);
 
         if(available == 0) {
             // get at least one element
             pcontrol->ensureData(sizeof(T));
             continue;
         }
 
         const size_t n2read = std::min(remaining, available);
 
         pbuffer->getArray(cur, n2read);
         cur += n2read;
         remaining -= n2read;
     }
     value = freeze(nextvalue);
     // TODO !!!
     // inform about the change?
     PVField::postPut();
 }

template<>

std::ostream & epics::pvData::PVValueArray< std::string >::dumpValue	(	std::ostream &	o,
		size_t	index
	)		const

Definition at line 234 of file PVDataCreateFactory.cpp.

 {
     return o << '"' << escape(this->view().at(index)) << '"';
 }

template<>

std::ostream & epics::pvData::PVValueArray< std::string >::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 240 of file PVDataCreateFactory.cpp.

 {
     const_svector v(this->view());
     const_svector::const_iterator it(v.begin()),
                                   end(v.end());
     o << '[';
     if(it!=end) {
         o << '"' << escape(*it++) << '"';
         for(; it!=end; ++it)
             o << ", \"" << escape(*it) << '"';
 
     }
     return o << ']';
 }

template<typename T >

std::ostream & epics::pvData::PVValueArray< T >::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 218 of file PVDataCreateFactory.cpp.

 {
     const_svector v(this->view());
     typename const_svector::const_iterator it(v.begin()),
                                   end(v.end());
     o << '[';
     if(it!=end) {
         o << print_cast(*it++);
         for(; it!=end; ++it)
             o << ',' << print_cast(*it);
 
     }
     return o << ']';
 }

template<typename T >

std::ostream & epics::pvData::PVValueArray< T >::dumpValue	(	std::ostream &	o,
		size_t	index
	)		const

virtual

Definition at line 256 of file PVDataCreateFactory.cpp.

 {
     return o << print_cast(this->view().at(index));
 }

template<typename T >

ArrayConstPtr epics::pvData::PVValueArray< T >::getArray ( ) const

virtual

Get introspection interface.

Implements epics::pvData::PVArray.

Definition at line 212 of file PVDataCreateFactory.cpp.

 {
     return std::tr1::static_pointer_cast<const Array>(this->getField());
 }

template<typename T>

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

inlinevirtual

Get the array capacity.

Returns: The capacity.

Implements epics::pvData::PVArray.

Definition at line 1204 of file pvData.h.

1204 {return value.capacity();}

value

Definition: link.h:174

template<typename T>

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

inlinevirtual

Get the array length.

Returns: The length.

Implements epics::pvData::PVArray.

Definition at line 1203 of file pvData.h.

1203 {return value.size();}

value

Definition: link.h:174

template<typename T>

epics::pvData::PVValueArray< T >::POINTER_DEFINITIONS ( PVValueArray< T > )

template<typename T >

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

virtual

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

Implements epics::pvData::detail::PVVectorStorage< T, PVScalarArray >.

Definition at line 290 of file PVDataCreateFactory.cpp.

 {
     this->checkLength(next.size());
 
     value = next;
     this->postPut();
 }

template<>

void epics::pvData::PVValueArray< string >::serialize	(	ByteBuffer *	pbuffer,
		SerializableControl *	pflusher,
		size_t	offset,
		size_t	count
	)		const

Definition at line 437 of file PVDataCreateFactory.cpp.

                                                                           {
 
     const_svector temp(value);
     temp.slice(offset, count);
 
     // TODO if fixed count == getArray()->getMaximumCapacity()
     if (this->getArray()->getArraySizeType() != Array::fixed)
         SerializeHelper::writeSize(temp.size(), pbuffer, pflusher);
 
     const string * pvalue = temp.data();
     for(size_t i = 0; i<temp.size(); i++) {
         SerializeHelper::serializeString(pvalue[i], pbuffer, pflusher);
     }
 }

template<typename T >

void epics::pvData::PVValueArray< T >::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 311 of file PVDataCreateFactory.cpp.

                                                  {
     serialize(pbuffer, pflusher, 0, this->getLength());
 }

template<typename T >

void epics::pvData::PVValueArray< T >::serialize	(	ByteBuffer *	pbuffer,
		SerializableControl *	pflusher,
		size_t	offset,
		size_t	count
	)		const

virtual

Definition at line 366 of file PVDataCreateFactory.cpp.

 {
     //TODO: avoid incrementing the ref counter...
     const_svector temp(value);
     temp.slice(offset, count);
     count = temp.size();
 
     ArrayConstPtr array = this->getArray();
     if (array->getArraySizeType() != Array::fixed)
         SerializeHelper::writeSize(count, pbuffer, pflusher);
     else if (count != array->getMaximumCapacity())
         throw std::length_error("fixed array cannot be partially serialized");
 
     const T* cur = temp.data();
 
     // try to avoid copying into the buffer
     // this is only possible if we do not need to do endian-swapping
     if (!pbuffer->reverse<T>())
         if (pflusher->directSerialize(pbuffer, (const char*)cur, count, sizeof(T)))
             return;
 
     while(count) {
         const size_t empty = pbuffer->getRemaining();
         const size_t space_for = empty/sizeof(T);
 
         if(space_for==0) {
             pflusher->flushSerializeBuffer();
             // Can we be certain that more space is now free???
             // If not then we spinnnnnnnnn
             continue;
         }
 
         const size_t n2send = std::min(count, space_for);
 
         pbuffer->putArray(cur, n2send);
         cur += n2send;
         count -= n2send;
     }
 }

template<typename T >

void epics::pvData::PVValueArray< T >::setCapacity ( size_t capacity )

virtual

Definition at line 262 of file PVDataCreateFactory.cpp.

 {
     if(this->isCapacityMutable()) {
         this->checkLength(capacity);
         value.reserve(capacity);
     }
     else
         THROW_EXCEPTION2(std::logic_error, "capacity immutable");
 }

template<typename T >

void epics::pvData::PVValueArray< T >::setLength ( size_t length )

virtual

Definition at line 273 of file PVDataCreateFactory.cpp.

 {
     if(this->isImmutable())
         THROW_EXCEPTION2(std::logic_error, "immutable");
 
     if (length == value.size())
         return;
 
     this->checkLength(length);
 
     if (length < value.size())
         value.slice(0, length);
     else
         value.resize(length);
 }

template<typename T >

void epics::pvData::PVValueArray< T >::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< T, PVScalarArray >.

Definition at line 299 of file PVDataCreateFactory.cpp.

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

template<typename T>

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

inlinevirtual

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

Implements epics::pvData::detail::PVVectorStorage< T, PVScalarArray >.

Definition at line 1209 of file pvData.h.

1209 {return value;}

epics::pvData::PVValueArray::value

const_svector value

Definition: pvData.h:1224

Friends And Related Function Documentation

template<typename T>

friend class PVDataCreate

friend

Definition at line 1225 of file pvData.h.

Member Data Documentation

template<typename T>

const ScalarType epics::pvData::PVStringArray::typeCode = pvBoolean

static

Definition at line 1188 of file pvData.h.

template<typename T>

const_svector epics::pvData::PVValueArray< T >::value

protected

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<typename T> class epics::pvData::PVValueArray< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename T>
class epics::pvData::PVValueArray< T >