[Core] Common Classes and Utilities

Classes
class	xmm::AttributeBase
	Base Class for Generic Attributes. More...
class	xmm::Attribute< T >
	Generic Attribute. More...
class	xmm::Attribute< std::vector< T > >
	Generic Attribute (Vector Specialization) More...
class	xmm::Attribute< std::vector< std::string > >
	Generic Attribute (Vector Specialization) More...
class	xmm::CircularBuffer< T, channels >
	Simple CircularBuffer Class. More...
class	xmm::EventGenerator< EventType >
	Generator class for a specific type of events. More...
class	xmm::Writable
	Abstract class for handling JSON + File I/O. More...
class	xmm::JsonException
	Exception class for handling JSON parsing errors. More...
class	xmm::Matrix< T >
	Dirty and very incomplete Matrix Class. More...

Functions
template<typename T >
void	xmm::checkLimits (T const &value, T const &limit_min, T const &limit_max)
	checks the validity of the requested value with respect to the current limits More...
template<typename T >
Json::Value	xmm::array2json (T const *a, unsigned int n)
	Writes a C-style array to a Json Value. More...
template<typename T >
void	xmm::json2array (Json::Value const &root, T *a, unsigned int n)
	Reads a C-style array from a Json Value. More...
template<typename T >
Json::Value	xmm::vector2json (std::vector< T > const &a)
	Writes a vector to a Json Value. More...
template<typename T >
void	xmm::json2vector (Json::Value const &root, std::vector< T > &a, unsigned int n)
	Reads a vector from a Json Value. More...

Detailed Description

Function Documentation

template<typename T >

Json::Value xmm::array2json	(	T const *	a,
		unsigned int	n
	)

Writes a C-style array to a Json Value.

Parameters

a	array
n	array size

Returns

Json Value containing the array in Json Format

template<typename T >

void xmm::checkLimits	(	T const &	value,
		T const &	limit_min,
		T const &	limit_max
	)

checks the validity of the requested value with respect to the current limits

Parameters

value	requested attribute value
limit_min	minimum value
limit_max	maximum value

template<typename T >

void xmm::json2array	(	Json::Value const &	root,
		T *	a,
		unsigned int	n
	)

Reads a C-style array from a Json Value.

Parameters

root	Json Value containing the array in Json Format
a	array
n	array size

template<typename T >

void xmm::json2vector	(	Json::Value const &	root,
		std::vector< T > &	a,
		unsigned int	n
	)

Reads a vector from a Json Value.

Parameters

root	Json Value containing the vector data in Json Format
a	vector
n	vector size

Warning

the target vector must already have the appropriate size

template<typename T >

Json::Value xmm::vector2json

(

std::vector< T > const &

a

)

Writes a vector to a Json Value.

Parameters

a

vector

Returns

Json Value containing the vector data in Json Format