Fixed size array of POD values. More...

#include <DataPieceArray.h>

Inheritance diagram for vrs::DataPieceArray< T >:

Public Member Functions
	DataPieceArray (string label, size_t count)

template<size_t n>
	DataPieceArray (string label, size_t count, const T(&defaultValues)[n])

	DataPieceArray (const MakerBundle &bundle)

size_t	getArraySize () const
	Get the size of the array.

const string &	getElementTypeName () const override

size_t	getVariableSize () const override

size_t	collectVariableData (int8_t *, size_t) override

bool	get (T *outValues, size_t count) const

bool	get (T &outValue, size_t index) const

bool	get (vector< T > &outValues) const

bool	set (const T *values, size_t count)

bool	set (const T &value, size_t index)

template<size_t n>
bool	set (const T(&arr)[n])

bool	set (const vector< T > &values)

void	setDefault (const T *defaultValues, size_t count)

template<size_t n>
void	setDefault (const T(&arr)[n])

void	setDefault (const vector< T > &values)

const vector< T > &	getDefault () const

void	initToDefault () override
	Initialize to default value.

void	setProperty (const string &propertyName, T value)

bool	getProperty (const string &propertyName, T &outValue) const

void	setMin (T min)

void	setMax (T max)

void	setRange (T min, T max)

bool	getMin (T &outMin) const

bool	getMax (T &outMax) const

bool	patchValue (const T *values, size_t count) const

bool	isAvailable () const override

void	print (ostream &out, const string &indent) const override

void	printCompact (ostream &out, const string &indent) const override

bool	isSame (const DataPiece *rhs) const override

void	serialize (JsonWrapper &jsonWrapper, const JsonFormatProfileSpec &profile) override

unique_ptr< DataPiece >	clone () const override

Public Member Functions inherited from vrs::DataPiece
const DataLayout &	getDataLayout () const

const string &	getLabel () const

DataPieceType	getPieceType () const

string	getTypeName () const

size_t	getPieceIndex () const

size_t	getOffset () const

bool	hasFixedSize () const

size_t	getFixedSize () const

bool	getTag (const string &tagName, string &outTag) const

void	setTag (const string &tagName, const string &tag)

bool	getUnit (string &outUnit) const

void	setUnit (const string &unit)

bool	getDescription (string &outDescription) const

void	setDescription (const string &description)

void	setRequired (bool required=true)

bool	isRequired () const

bool	isMapped () const
	Tells if the DataPiece is mapped to another DataPiece in a mapped DataLayout.

virtual bool	stageCurrentValue ()

Protected Member Functions
bool	copyFrom (const DataPiece *original) override
	Set or stage value from another piece known to be of the same type.

Protected Member Functions inherited from vrs::DataPiece
	DataPiece (string label, DataPieceType type, size_t size)

bool	isMatch (const DataPiece &rhs) const
	Match signature only.

void	setIndexOffset (size_t pieceIndex, size_t offset)

Additional Inherited Members
Protected Attributes inherited from vrs::DataPiece
const string	label_

const DataPieceType	pieceType_

const size_t	fixedSize_

size_t	pieceIndex_

size_t	offset_

DataLayout &	layout_

map< string, string >	tags_

bool	required_

Static Protected Attributes inherited from vrs::DataPiece
static const string	kUnit = "unit"
	Special tag name to specify a unit of the DataPiece.

static const string	kDescription = "description"
	Special tag name to specify a human readable description the DataPiece.

static const string	kMinValue = "min"
	Special property name for the minimum value of the DataPiece.

static const string	kMaxValue = "max"
	Special property name for the maximum value of the DataPiece.

static const string	kMinIncrement = "min_increment"
	Special property name for the minimum increment of the DataPiece.

static const string	kMaxIncrement = "max_increment"
	Special property name for the maximum increment of the DataPiece.

Detailed Description

template<typename T>
class vrs::DataPieceArray< T >

Fixed size array of POD values.

Array of type T and fixed size. The array is stored in DataLayout's fixed size buffer. The size of the array is defined at construction and may not change.

Constructor & Destructor Documentation

◆ DataPieceArray() [1/3]

template<typename T >

vrs::DataPieceArray< T >::DataPieceArray	(	string	label,
		size_t	count
	)

inline

Parameters

label	Name for the DataPiece.
count	Number of elements in the fixes size-array.

◆ DataPieceArray() [2/3]

template<typename T >

template<size_t n>

vrs::DataPieceArray< T >::DataPieceArray	(	string	label,
		size_t	count,
		const T(&)	defaultValues[n]
	)

inline

Parameters

label	Name for the DataPiece.
count	Number of elements in the fixes size-array.
defaultValues	Static array of default values.

◆ DataPieceArray() [3/3]

template<typename T >

vrs::DataPieceArray< T >::DataPieceArray ( const MakerBundle & bundle )

explicit

Parameters

bundle Bundle to reconstruct a DataPieceArray from disk.

Member Function Documentation

◆ clone()

template<typename T >

unique_ptr< DataPiece > vrs::DataPieceArray< T >::clone ( ) const

inlineoverridevirtual

Clone data piece.

Returns: A clone of the data piece, with the same label, same type and same size. All the other data piece properties (default value and properties) are not cloned.

Implements vrs::DataPiece.

◆ collectVariableData()

template<typename T >

size_t vrs::DataPieceArray< T >::collectVariableData	(	int8_t *	,
		size_t
	)

inlineoverridevirtual

Copy staged variable-size data to a specific location. [doesn't apply].

Implements vrs::DataPiece.

◆ copyFrom()

template<typename T >

bool vrs::DataPieceArray< T >::copyFrom ( const DataPiece * original )

inlineoverrideprotectedvirtual

Set or stage value from another piece known to be of the same type.

Implements vrs::DataPiece.

◆ get() [1/3]

template<typename T >

bool vrs::DataPieceArray< T >::get	(	T &	outValue,
		size_t	index
	)		const

inline

get specific value in the array, by index.

Parameters

outValue	Reference to a value to set.
index	Value requested.

Returns: True if an actual data value was read. False, if a default value was used, or T's default constructor.

◆ get() [2/3]

template<typename T >

bool vrs::DataPieceArray< T >::get	(	T *	outValues,
		size_t	count
	)		const

inline

copy a given number of values to a given location. If not enough values are available, default values are written. If not enough default values are available, T's default constructor is used to fill-in.

Parameters

outValues	Pointer where to write the data.
count	Number of values requested.

Returns: True if the requested number of actual data values were copied, even if there were more values available than requested. Return false in all other cases.

◆ get() [3/3]

template<typename T >

bool vrs::DataPieceArray< T >::get ( vector< T > & outValues ) const

inline

Get values or default values.

Parameters

outValues Vector to set.

Returns: True if actual data values were set, false if default values were read.

◆ getDefault()

template<typename T >

const vector< T > & vrs::DataPieceArray< T >::getDefault ( ) const

inline

Get the default value returned by get() when the DataPiece is not mapped.

Returns: Default values. The vector is empty if no default values were set.

◆ getElementTypeName()

template<typename T >

const string & vrs::DataPieceArray< T >::getElementTypeName ( ) const

inlineoverridevirtual

Get the name of the element type <T>.

Implements vrs::DataPiece.

◆ getMax()

template<typename T >

bool vrs::DataPieceArray< T >::getMax ( T & outMax ) const

inline

Get maximum value for each element of the array.

Parameters

outMax Reference to set to the maximum valid value.

Returns: True if there is maximum value & outMax was set.

◆ getMin()

template<typename T >

bool vrs::DataPieceArray< T >::getMin ( T & outMin ) const

inline

Get minimum value for each element of the array.

Parameters

outMin Reference to set to the minimum valid value.

Returns: True if there is minimum value & outMin was set.

◆ getProperty()

template<typename T >

bool vrs::DataPieceArray< T >::getProperty	(	const string &	propertyName,
		T &	outValue
	)		const

inline

Get a property

Parameters

propertyName	Name of the property.
outValue	Reference to a value to set.

Returns: True if the property exists and outValue was set, false otherwise.

◆ getVariableSize()

template<typename T >

size_t vrs::DataPieceArray< T >::getVariableSize ( ) const

inlineoverridevirtual

Get variable-size. 0 here, since this is a fixed size DataPiece. [doesn't apply].

Implements vrs::DataPiece.

◆ initToDefault()

template<typename T >

void vrs::DataPieceArray< T >::initToDefault ( )

inlineoverridevirtual

Initialize to default value.

Implements vrs::DataPiece.

◆ isAvailable()

template<typename T >

bool vrs::DataPieceArray< T >::isAvailable ( ) const

inlineoverridevirtual

Tell if a DataPiece value is available.

Returns: True if the value is available, false if the DataPiece could not be mapped.

Implements vrs::DataPiece.

◆ isSame()

template<typename T >

bool vrs::DataPieceArray< T >::isSame ( const DataPiece * rhs ) const

overridevirtual

Compare two DataPiece objects for their equivalence. Note: the values are not compared, all the other properties are (type, name, tags, etc).

Parameters

rhs	Other DataPiece to compare to.

Returns: True if the DataPiece objects are considered the same.

Reimplemented from vrs::DataPiece.

◆ patchValue()

template<typename T >

bool vrs::DataPieceArray< T >::patchValue	(	const T *	values,
		size_t	count
	)		const

inline

Patch values in the mapped DataLayout. This method is named patchValue, because it's meant to edit a DataLayout found in a file, when doing a filter-copy operation.

Returns: True if the piece is mapped and the values were set.

◆ print()

template<typename T >

void vrs::DataPieceArray< T >::print	(	ostream &	out,
		const string &	indent
	)		const

overridevirtual

Print the DataPiece to the out stream, with many details, using indent text at the start of each line of output.

Parameters

out	Output stream to print to.
indent	Text to insert at the beginning of each output line, for indentation purposes.

Implements vrs::DataPiece.

◆ printCompact()

template<typename T >

void vrs::DataPieceArray< T >::printCompact	(	ostream &	out,
		const string &	indent
	)		const

overridevirtual

Print the DataPiece to the out stream in compact form, using indent text at the start of each line of output.

Parameters

out	Output stream to print to.
indent	Text to insert at the beginning of each output line, for indentation purposes.

Implements vrs::DataPiece.

◆ serialize()

template<typename T >

void vrs::DataPieceArray< T >::serialize	(	JsonWrapper &	jsonWrapper,
		const JsonFormatProfileSpec &	profile
	)

overridevirtual

Export the DataPiece as json, using a specific profile.

Parameters

jsonWrapper	Wrapper around a json type (to isolate any 3rd party library dependency).
profile	Profile describing what information needs to be exported as json.

Reimplemented from vrs::DataPiece.

◆ set() [1/4]

template<typename T >

bool vrs::DataPieceArray< T >::set	(	const T &	value,
		size_t	index
	)

inline

Set one value of the array.

Parameters

value	Reference to the value to write.
index	Index of the array element to set.

Returns: True if the array was large enough, and the value could be written. Note: does not touch the other array values.

◆ set() [2/4]

template<typename T >

bool vrs::DataPieceArray< T >::set	(	const T *	values,
		size_t	count
	)

inline

Set array values.

Parameters

values	pointer to values to write.
count	Number of values to write.

Returns: True if values were written. Note: if more values are given than the size of the array, fewer values will be written, but the method still returns true. If not enough values are given to set the whole array, T's default constructor is used to init the remaining values.

◆ set() [3/4]

template<typename T >

template<size_t n>

bool vrs::DataPieceArray< T >::set ( const T(&) arr[n] )

inline

Set array values.

Parameters

arr	C-style array.

Returns: True if values were written. Note: if more values are given than the size of the array, fewer values will be written, but the method still returns true. If not enough values are given to set the whole array, T's default constructor is used to init the remaining values.

◆ set() [4/4]

template<typename T >

bool vrs::DataPieceArray< T >::set ( const vector< T > & values )

inline

Set array values.

Parameters

values Vector of values to write.

Returns: True if values were written. Note: if more values are given than the size of the array, fewer values will be written, but the method still returns true. If not enough values are given to set the whole array, T's default constructor is used to init the remaining values.

◆ setDefault() [1/3]

template<typename T >

void vrs::DataPieceArray< T >::setDefault	(	const T *	defaultValues,
		size_t	count
	)

inline

Specify a default value returned by get() when the DataPiece is not mapped. This value is not automatically used as an initialization value for the DataPiece. Use initToDefault() or DataLayout::initDataPiecesToDefaultValue() for that.

Parameters

defaultValues	Pointer to the first default value.
count	Number of default values to use. Note: if fewer default values are passed that the size of the array, T's default constructor is used to have the exact count of default values.

◆ setDefault() [2/3]

template<typename T >

template<size_t n>

void vrs::DataPieceArray< T >::setDefault ( const T(&) arr[n] )

inline

Specify a default value returned by get() when the DataPiece is not mapped. This value is not automatically used as an initialization value for the DataPiece. Use initToDefault() or DataLayout::initDataPiecesToDefaultValue() for that.

Parameters

arr	C-style array ot default values. Note: if fewer default values are passed that the size of the array, T's default constructor is used to have the exact count of default values.

◆ setDefault() [3/3]

template<typename T >

void vrs::DataPieceArray< T >::setDefault ( const vector< T > & values )

inline

Specify a default value returned by get() when the DataPiece is not mapped. This value is not automatically used as an initialization value for the DataPiece. Use initToDefault() or DataLayout::initDataPiecesToDefaultValue() for that.

Parameters

defaultValues Vector of default values. Note: if fewer default values are passed that the size of the array, T's default constructor is used to have the exact count of default values.

◆ setMax()

template<typename T >

void vrs::DataPieceArray< T >::setMax ( T max )

inline

Set the maximum valid value for each element of the array.

Parameters

max	Maximum valid value. Note: max checking is a sanity check operation only. Nothing prevents users of the API to set the values of the array any way they want.

◆ setMin()

template<typename T >

void vrs::DataPieceArray< T >::setMin ( T min )

inline

Set the minimum valid value for each element of the array.

Parameters

min	Minimum valid value. Note: min checking is a sanity check operation only. Nothing prevents users of the API to set the values of the array any way they want.

◆ setProperty()

template<typename T >

void vrs::DataPieceArray< T >::setProperty	(	const string &	propertyName,
		T	value
	)

inline

Set a property.

Parameters

propertyName	Name of the property.
value	Value of the property.

◆ setRange()

template<typename T >

void vrs::DataPieceArray< T >::setRange	(	T	min,
		T	max
	)

inline

Set the min & max valid values for each element of the array.

Parameters

min	Minimum valid value.
max	Maximum valid value. Note: min/max checking is a sanity check operation only. Nothing prevents users of the API to set the values of the array any way they want.

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

vrs/DataLayout.h
vrs/DataPieceArray.h
vrs/DataLayout.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataPieceArray() [1/3]

◆ DataPieceArray() [2/3]

◆ DataPieceArray() [3/3]

Member Function Documentation

◆ clone()

◆ collectVariableData()

◆ copyFrom()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getDefault()

◆ getElementTypeName()

◆ getMax()

◆ getMin()

◆ getProperty()

◆ getVariableSize()

◆ initToDefault()

◆ isAvailable()

◆ isSame()

◆ patchValue()

◆ print()

◆ printCompact()

◆ serialize()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ setDefault() [1/3]

◆ setDefault() [2/3]

◆ setDefault() [3/3]

◆ setMax()

◆ setMin()

◆ setProperty()

◆ setRange()