ReaderInterface< I > Class Template Referenceabstract

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

Public Types

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

Public Member Functions

virtual data::Descriptor getDescriptor (InputType &input)=0
 
void readBool (InputType &input, bool &i)
 
virtual void readBool (InputType &input, bool &i, Path &)=0
 
void readDict (InputType &input, std::map< std::string, InputTypeNonConst > &elements)
 
virtual void readDict (InputType &input, std::map< std::string, InputTypeNonConst > &elements, Path &)=0
 
void readDouble (InputType &input, double &i)
 
virtual void readDouble (InputType &input, double &i, Path &)=0
 
void readFloat (InputType &input, float &i)
 
virtual void readFloat (InputType &input, float &i, Path &)=0
 
void readInt (InputType &input, int &i)
 
virtual void readInt (InputType &input, int &i, Path &)=0
 
void readList (InputType &input, std::vector< InputTypeNonConst > &elements)
 
virtual void readList (InputType &input, std::vector< InputTypeNonConst > &elements, Path &)=0
 
void readLong (InputType &input, long &i)
 
virtual void readLong (InputType &input, long &i, Path &)=0
 
void readNDArray (InputType &input, std::vector< int > &shape, std::string &typeAsString, std::vector< unsigned char > &data)
 
virtual void readNDArray (InputType &input, std::vector< int > &shape, std::string &typeAsString, std::vector< unsigned char > &data, Path &)=0
 
virtual bool readNull (InputType &input)
 
void readPrimitive (InputType &input, bool &i)
 
void readPrimitive (InputType &input, bool &i, Path &p)
 
void readPrimitive (InputType &input, double &i)
 
void readPrimitive (InputType &input, double &i, Path &p)
 
void readPrimitive (InputType &input, float &i)
 
void readPrimitive (InputType &input, float &i, Path &p)
 
void readPrimitive (InputType &input, int &i)
 
void readPrimitive (InputType &input, int &i, Path &p)
 
void readPrimitive (InputType &input, long &i)
 
void readPrimitive (InputType &input, long &i, Path &p)
 
void readPrimitive (InputType &input, std::string &i)
 
void readPrimitive (InputType &input, std::string &i, Path &p)
 
void readString (InputType &input, std::string &s)
 
virtual void readString (InputType &input, std::string &s, Path &)=0
 
virtual ~ReaderInterface ()=default
 

Detailed Description

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

Definition at line 36 of file Reader.h.

Member Typedef Documentation

◆ InputType

using InputType = I

Definition at line 39 of file Reader.h.

◆ InputTypeNonConst

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

Definition at line 40 of file Reader.h.

Constructor & Destructor Documentation

◆ ~ReaderInterface()

virtual ~ReaderInterface ( )
virtualdefault

Member Function Documentation

◆ getDescriptor()

virtual data::Descriptor getDescriptor ( InputType input)
pure virtual

◆ readBool() [1/2]

void readBool ( InputType input,
bool &  i 
)
inline

Definition at line 144 of file Reader.h.

◆ readBool() [2/2]

virtual void readBool ( InputType input,
bool &  i,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readDict() [1/2]

void readDict ( InputType input,
std::map< std::string, InputTypeNonConst > &  elements 
)
inline

Definition at line 102 of file Reader.h.

◆ readDict() [2/2]

virtual void readDict ( InputType input,
std::map< std::string, InputTypeNonConst > &  elements,
Path  
)
pure virtual

Implemented in NlohmannJSONReader, NlohmannJSONReaderWithoutTypeCheck, and VariantReader.

+ Here is the caller graph for this function:

◆ readDouble() [1/2]

void readDouble ( InputType input,
double &  i 
)
inline

Definition at line 132 of file Reader.h.

◆ readDouble() [2/2]

virtual void readDouble ( InputType input,
double &  i,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readFloat() [1/2]

void readFloat ( InputType input,
float i 
)
inline

Definition at line 126 of file Reader.h.

◆ readFloat() [2/2]

virtual void readFloat ( InputType input,
float i,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readInt() [1/2]

void readInt ( InputType input,
int &  i 
)
inline

Definition at line 114 of file Reader.h.

◆ readInt() [2/2]

virtual void readInt ( InputType input,
int &  i,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readList() [1/2]

void readList ( InputType input,
std::vector< InputTypeNonConst > &  elements 
)
inline

Definition at line 96 of file Reader.h.

◆ readList() [2/2]

virtual void readList ( InputType input,
std::vector< InputTypeNonConst > &  elements,
Path  
)
pure virtual

Implemented in NlohmannJSONReader, NlohmannJSONReaderWithoutTypeCheck, and VariantReader.

+ Here is the caller graph for this function:

◆ readLong() [1/2]

void readLong ( InputType input,
long &  i 
)
inline

Definition at line 120 of file Reader.h.

◆ readLong() [2/2]

virtual void readLong ( InputType input,
long &  i,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readNDArray() [1/2]

void readNDArray ( InputType input,
std::vector< int > &  shape,
std::string &  typeAsString,
std::vector< unsigned char > &  data 
)
inline

Definition at line 108 of file Reader.h.

◆ readNDArray() [2/2]

virtual void readNDArray ( InputType input,
std::vector< int > &  shape,
std::string &  typeAsString,
std::vector< unsigned char > &  data,
Path  
)
pure virtual

Implemented in NlohmannJSONReaderWithoutTypeCheck, NlohmannJSONReader, and VariantReader.

+ Here is the caller graph for this function:

◆ readNull()

virtual bool readNull ( InputType input)
inlinevirtual

Definition at line 58 of file Reader.h.

◆ readPrimitive() [1/12]

void readPrimitive ( InputType input,
bool &  i 
)
inline

Definition at line 175 of file Reader.h.

◆ readPrimitive() [2/12]

void readPrimitive ( InputType input,
bool &  i,
Path p 
)
inline

Definition at line 90 of file Reader.h.

◆ readPrimitive() [3/12]

void readPrimitive ( InputType input,
double &  i 
)
inline

Definition at line 165 of file Reader.h.

◆ readPrimitive() [4/12]

void readPrimitive ( InputType input,
double &  i,
Path p 
)
inline

Definition at line 80 of file Reader.h.

◆ readPrimitive() [5/12]

void readPrimitive ( InputType input,
float i 
)
inline

Definition at line 160 of file Reader.h.

◆ readPrimitive() [6/12]

void readPrimitive ( InputType input,
float i,
Path p 
)
inline

Definition at line 75 of file Reader.h.

◆ readPrimitive() [7/12]

void readPrimitive ( InputType input,
int &  i 
)
inline

Definition at line 150 of file Reader.h.

◆ readPrimitive() [8/12]

void readPrimitive ( InputType input,
int &  i,
Path p 
)
inline

Definition at line 65 of file Reader.h.

◆ readPrimitive() [9/12]

void readPrimitive ( InputType input,
long &  i 
)
inline

Definition at line 155 of file Reader.h.

◆ readPrimitive() [10/12]

void readPrimitive ( InputType input,
long &  i,
Path p 
)
inline

Definition at line 70 of file Reader.h.

◆ readPrimitive() [11/12]

void readPrimitive ( InputType input,
std::string &  i 
)
inline

Definition at line 170 of file Reader.h.

◆ readPrimitive() [12/12]

void readPrimitive ( InputType input,
std::string &  i,
Path p 
)
inline

Definition at line 85 of file Reader.h.

◆ readString() [1/2]

void readString ( InputType input,
std::string &  s 
)
inline

Definition at line 138 of file Reader.h.

◆ readString() [2/2]

virtual void readString ( InputType input,
std::string &  s,
Path  
)
pure virtual

Implemented in NlohmannJSONReader, VariantReader, and NlohmannJSONReaderWithoutTypeCheck.

+ Here is the caller graph for this function:

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