Abstract class representing a piece of information part of a DataLayout. More...

#include <DataPieces.h>

Inheritance diagram for vrs::DataPiece:

Classes
struct	MakerBundle

Public Member Functions
const DataLayout &	getDataLayout () const

const string &	getLabel () const

DataPieceType	getPieceType () const

string	getTypeName () 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

virtual size_t	getVariableSize () const =0

virtual size_t	collectVariableData (int8_t *data, size_t bufferSize)=0

virtual const string &	getElementTypeName () const =0

virtual bool	isAvailable () const =0

virtual void	print (ostream &out, const string &indent="") const =0

virtual void	printCompact (ostream &out, const string &indent="") const =0

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

virtual bool	stageCurrentValue ()

virtual unique_ptr< DataPiece >	clone () const =0
	Create a new DataPiece of the same type, with the same label.

Protected Member Functions
	DataPiece (const string &label, DataPieceType type, size_t size)

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

virtual bool	isSame (const DataPiece *rhs) const
	Match signature & properties (default value, min/max, etc).

void	setOffset (size_t offset)

virtual bool	stageFrom (const DataPiece *original)=0
	Stage value from another piece known to be of the same type.

Protected Attributes
const string	label_

const DataPieceType	pieceType_

const size_t	fixedSize_

size_t	offset_

DataLayout &	layout_

map< string, string >	tags_

bool	required_

Static Protected Attributes
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.

Friends
class	DataLayout

Detailed Description

Abstract class representing a piece of information part of a DataLayout.

DataPiece objects have a type (DataPieceType) and label (a text name), which together are enough to identify uniquely a DataPiece of a particular DataLayout. See DataLayout for more details.

Constructor & Destructor Documentation

◆ DataPiece()

vrs::DataPiece::DataPiece	(	const string &	label,
		DataPieceType	type,
		size_t	size
	)

protected

Constructor, called by derived types exclusively.

Parameters

label	Text name.
type	A DataPieceType.
size	Size in bytes of the DataPiece, or the constant: DataLayout::kVariableSize.

Member Function Documentation

◆ clone()

virtual unique_ptr< DataPiece > vrs::DataPiece::clone ( ) const

pure virtual

◆ collectVariableData()

virtual size_t vrs::DataPiece::collectVariableData	(	int8_t *	data,
		size_t	bufferSize
	)

pure virtual

Copy the staged variable-size to a location.

Parameters

data	Pointer where to copy the variable-size data.
bufferSize	Max number of bytes to copy.

Returns: Number of bytes actually copied.

◆ getDataLayout()

const DataLayout & vrs::DataPiece::getDataLayout ( ) const

inline

Get the DataLayout owning this DataPiece.

Returns: The DataLayout.

◆ getDescription()

bool vrs::DataPiece::getDescription ( string & outDescription ) const

inline

Get the description of a DataPiece.

Parameters

outDescription Reference to a string to set.

Returns: True, if the unit tag was found, and outDescription was set. False, otherwise.

◆ getElementTypeName()

virtual const string & vrs::DataPiece::getElementTypeName ( ) const

pure virtual

Get the name of the template element type T of the derived template class, or "string" in the case of DataPieceString.

Returns: The DataPiece's element type name.

◆ getFixedSize()

size_t vrs::DataPiece::getFixedSize ( ) const

inline

Get the number of bytes needed to store the DataPiece's value.

Returns: A number of bytes, or DataLayout::kVariableSize.

◆ getLabel()

const string & vrs::DataPiece::getLabel ( ) const

inline

Get the text label of this DataPiece.

Returns: The label.

◆ getOffset()

size_t vrs::DataPiece::getOffset ( ) const

inline

Get the offset of the DataPiece in the DataLayout. For fixed-size DataPiece objects, it's the memory index in the fixed size data buffer. For variable-size DataPiece objects, it's the index of the variable DataPiece. For both: if the DataLayout was mapped to another, but this particular DataPiece could not be mapped in the target DataLayout, the offset value is set to DataLayout::kNotFound.

Returns: Offset value, or DataLayout::kNotFound if the DataPiece was not mapped.

◆ getPieceType()

DataPieceType vrs::DataPiece::getPieceType ( ) const

inline

Get the type of the DataPiece.

Returns: The DataPieceType.

◆ getTag()

bool vrs::DataPiece::getTag	(	const string &	tagName,
		string &	outTag
	)		const

Get a DataPiece tag.

Parameters

tagName	Name of the tag to retrieve.
outTag	Reference to a string to set.

Returns: True, if the tag was found, and outTag was set. False, otherwise.

◆ getTypeName()

string vrs::DataPiece::getTypeName ( ) const

Get the type name of the DataPiece.

Returns: PieceTypeName<DataType> e.g. "value<double>"

◆ getUnit()

bool vrs::DataPiece::getUnit ( string & outUnit ) const

inline

Get the unit of a DataPiece.

Parameters

outUnit Reference to a string to set.

Returns: True, if the unit tag was found, and outUnit was set. False, otherwise.

◆ getVariableSize()

virtual size_t vrs::DataPiece::getVariableSize ( ) const

pure virtual

Get the size of variable-size DataPiece staged value.

Returns: 0 for fixed-size DataPieces, otherwise, the number of bytes required to store the variable-size staged value.

◆ hasFixedSize()

bool vrs::DataPiece::hasFixedSize ( ) const

inline

Tell if the DataPiece has a fixed-size.

Returns: True if the DataPiece needs the same memory space, no matter what the value is.

◆ isAvailable()

virtual bool vrs::DataPiece::isAvailable ( ) const

pure virtual

Tell if the DataPiece is available.

Returns: True if the DataLayout was not mapped, or if a matching DataPiece was found, False if the DataLayout was mapped and no matching DataPiece was found.

◆ isRequired()

bool vrs::DataPiece::isRequired ( ) const

inline

Tell if the DataPiece requires to be mapped for the mapping of the DataLayout to be considered successful.

Returns: True if the DataPiece must be mapped.

◆ isSame()

bool vrs::DataPiece::isSame ( const DataPiece * rhs ) const

protectedvirtual

◆ print()

virtual void vrs::DataPiece::print	(	ostream &	out,
		const string &	indent = `""`
	)		const

pure virtual

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.

◆ printCompact()

virtual void vrs::DataPiece::printCompact	(	ostream &	out,
		const string &	indent = `""`
	)		const

pure virtual

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.

◆ serialize()

void vrs::DataPiece::serialize	(	JsonWrapper &	jsonWrapper,
		const JsonFormatProfileSpec &	profile
	)

virtual

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.

◆ setDescription()

void vrs::DataPiece::setDescription ( const string & description )

inline

Set the description of a DataPiece.

Parameters

description Human readable description of the DataPiece.

◆ setRequired()

void vrs::DataPiece::setRequired ( bool required = true )

inline

Specify if the DataPiece is required when mapping to another DataLayout.

Parameters

required True if mapping the DataPiece successfully is required.

◆ setTag()

void vrs::DataPiece::setTag	(	const string &	tagName,
		const string &	tag
	)

inline

Set a DataPiece tag.

Parameters

tagName	Name of the tag to set.
tag	Value of the tag.

◆ setUnit()

void vrs::DataPiece::setUnit ( const string & unit )

inline

Set the unit of a DataPiece.

Parameters

unit	Unit of the DataPiece (preferably, a SI unit like "m", or "ms").

◆ stageCurrentValue()

virtual bool vrs::DataPiece::stageCurrentValue ( )

inlinevirtual

Take the current value of the field, and stage it for writing during record creation. This operation does nothing for fixed size fields, which value & stage data are the same. For variable size fields, the value is read from the DataLayout's variable size data buffer, and staged as the value to write out.

Returns: True if the value is available and was staged.

Reimplemented in vrs::DataPieceString, vrs::DataPieceStringMap< T >, vrs::DataPieceStringMap< Matrix4Dd >, vrs::DataPieceStringMap< string >, vrs::DataPieceVector< T >, vrs::DataPieceVector< float >, vrs::DataPieceVector< Point3Df >, vrs::DataPieceVector< string >, and vrs::DataPieceVector< vrs::MatrixND >.

◆ stageFrom()

virtual bool vrs::DataPiece::stageFrom ( const DataPiece * original )

protectedpure virtual

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

vrs/DataPieces.h
vrs/DataLayout.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DataPiece()

Member Function Documentation

◆ clone()

◆ collectVariableData()

◆ getDataLayout()

◆ getDescription()

◆ getElementTypeName()

◆ getFixedSize()

◆ getLabel()

◆ getOffset()

◆ getPieceType()

◆ getTag()

◆ getTypeName()

◆ getUnit()

◆ getVariableSize()

◆ hasFixedSize()

◆ isAvailable()

◆ isRequired()

◆ isSame()

◆ print()

◆ printCompact()

◆ serialize()

◆ setDescription()

◆ setRequired()

◆ setTag()

◆ setUnit()

◆ stageCurrentValue()

◆ stageFrom()