#include <RobotAPI/libraries/aron/core/type/rw/Reader.h>

Inheritance diagram for ReaderInterface< I >:

Public Types
using	InputType = I

using	InputTypeNonConst = typename std::remove_const< InputType >::type

Public Member Functions
virtual type::Descriptor	getDescriptor (InputType &input)=0

virtual void	readAnyObject (const InputType &input, type::Maybe &maybe, Path &p)=0
	Extract information from an time type. More...

virtual void	readBool (const InputType &input, std::optional< bool > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an bool type. More...

virtual void	readDict (const InputType &input, InputTypeNonConst &acceptedType, type::Maybe &maybe, Path &p)=0
	Extract information from a dict type. More...

virtual void	readDouble (const InputType &input, std::optional< double > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an double type. More...

virtual void	readFloat (const InputType &input, std::optional< float > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an float type. More...

virtual void	readImage (const InputType &input, type::image::PixelType &type, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an image type. More...

virtual void	readInt (const InputType &input, std::optional< int > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an int type. More...

virtual void	readIntEnum (const InputType &input, std::string &name, std::map< std::string, int > &acceptedValues, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an int enum type. More...

virtual void	readList (const InputType &input, InputTypeNonConst &acceptedType, type::Maybe &maybe, Path &p)=0
	Extract information from a list type. More...

virtual void	readLong (const InputType &input, std::optional< long > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an long type. More...

virtual void	readMatrix (const InputType &input, int &rows, int &cols, type::matrix::ElementType &type, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from a matrix type. More...

virtual void	readNDArray (const InputType &input, int &ndim, type::ndarray::ElementType &type, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from a ndarray type. More...

virtual bool	readNull (InputType &input)
	Check if input is null. More...

virtual void	readObject (const InputType &input, std::string &name, std::vector< std::string > &templates, std::vector< std::string > &templateInstantiations, std::map< std::string, InputTypeNonConst > &memberTypes, type::Maybe &maybe, Path &p)=0
	Extract information from an Object type. More...

virtual void	readPair (const InputType &input, InputTypeNonConst &acceptedTypes1, InputTypeNonConst &acceptedTypes2, type::Maybe &maybe, Path &p)=0
	Extract information from a pair type. More...

virtual void	readPointCloud (const InputType &input, type::pointcloud::VoxelType &type, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from a pointcloud type. More...

virtual void	readQuaternion (const InputType &input, type::quaternion::ElementType &type, std::string &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from a quaternion type. More...

virtual void	readString (const InputType &input, std::optional< std::string > &defaultValue, type::Maybe &maybe, Path &p)=0
	Extract information from an string type. More...

virtual void	readTuple (const InputType &input, std::vector< InputTypeNonConst > &acceptedTypes, type::Maybe &maybe, Path &p)=0
	Extract information from a tuple type. More...

virtual	~ReaderInterface ()=default

Detailed Description

template<class I>
class armarx::aron::type::ReaderInterface< I >

The ReaderInterface class.

It defines the interface to extract information from an aron representation

Definition at line 38 of file Reader.h.

Member Typedef Documentation

◆ InputType

using InputType = I

Definition at line 41 of file Reader.h.

◆ InputTypeNonConst

using InputTypeNonConst = typename std::remove_const<InputType>::type

Definition at line 42 of file Reader.h.

Constructor & Destructor Documentation

◆ ~ReaderInterface()

virtual ~ReaderInterface ( )

virtualdefault

Member Function Documentation

◆ getDescriptor()

virtual type::Descriptor getDescriptor ( InputType & input )

pure virtual

Implemented in NlohmannJSONReader, and VariantReader.

◆ readAnyObject()

virtual void readAnyObject	(	const InputType &	input,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an time type.

◆ readBool()

virtual void readBool	(	const InputType &	input,
		std::optional< bool > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an bool type.

◆ readDict()

virtual void readDict	(	const InputType &	input,
		InputTypeNonConst &	acceptedType,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a dict type.

◆ readDouble()

virtual void readDouble	(	const InputType &	input,
		std::optional< double > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an double type.

◆ readFloat()

virtual void readFloat	(	const InputType &	input,
		std::optional< float > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an float type.

◆ readImage()

virtual void readImage	(	const InputType &	input,
		type::image::PixelType &	type,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an image type.

◆ readInt()

virtual void readInt	(	const InputType &	input,
		std::optional< int > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an int type.

◆ readIntEnum()

virtual void readIntEnum	(	const InputType &	input,
		std::string &	name,
		std::map< std::string, int > &	acceptedValues,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an int enum type.

◆ readList()

virtual void readList	(	const InputType &	input,
		InputTypeNonConst &	acceptedType,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a list type.

◆ readLong()

virtual void readLong	(	const InputType &	input,
		std::optional< long > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an long type.

◆ readMatrix()

virtual void readMatrix	(	const InputType &	input,
		int &	rows,
		int &	cols,
		type::matrix::ElementType &	type,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a matrix type.

◆ readNDArray()

virtual void readNDArray	(	const InputType &	input,
		int &	ndim,
		type::ndarray::ElementType &	type,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a ndarray type.

◆ readNull()

virtual bool readNull ( InputType & input )

inlinevirtual

Check if input is null.

Definition at line 169 of file Reader.h.

◆ readObject()

virtual void readObject	(	const InputType &	input,
		std::string &	name,
		std::vector< std::string > &	templates,
		std::vector< std::string > &	templateInstantiations,
		std::map< std::string, InputTypeNonConst > &	memberTypes,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an Object type.

◆ readPair()

virtual void readPair	(	const InputType &	input,
		InputTypeNonConst &	acceptedTypes1,
		InputTypeNonConst &	acceptedTypes2,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a pair type.

◆ readPointCloud()

virtual void readPointCloud	(	const InputType &	input,
		type::pointcloud::VoxelType &	type,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a pointcloud type.

◆ readQuaternion()

virtual void readQuaternion	(	const InputType &	input,
		type::quaternion::ElementType &	type,
		std::string &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a quaternion type.

◆ readString()

virtual void readString	(	const InputType &	input,
		std::optional< std::string > &	defaultValue,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from an string type.

◆ readTuple()

virtual void readTuple	(	const InputType &	input,
		std::vector< InputTypeNonConst > &	acceptedTypes,
		type::Maybe &	maybe,
		Path &	p
	)

pure virtual

Extract information from a tuple type.

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

RobotAPI/libraries/aron/core/type/rw/Reader.h

Public Types

Public Member Functions

Detailed Description

template<class I> class armarx::aron::type::ReaderInterface< I >

Member Typedef Documentation

◆ InputType

◆ InputTypeNonConst

Constructor & Destructor Documentation

◆ ~ReaderInterface()

Member Function Documentation

◆ getDescriptor()

◆ readAnyObject()

◆ readBool()

◆ readDict()

◆ readDouble()

◆ readFloat()

◆ readImage()

◆ readInt()

◆ readIntEnum()

◆ readList()

◆ readLong()

◆ readMatrix()

◆ readNDArray()

◆ readNull()

◆ readObject()

◆ readPair()

◆ readPointCloud()

◆ readQuaternion()

◆ readString()

◆ readTuple()

template<class I>
class armarx::aron::type::ReaderInterface< I >