List of all members | Public Types | Public Member Functions
WriterInterface< R > Class Template Referenceabstract

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

Public Types

using ReturnType = R
 
using ReturnTypeConst = typename std::add_const< ReturnType >::type
 

Public Member Functions

virtual data::Descriptor getDescriptor (ReturnTypeConst &input)=0
 
virtual ReturnType writeBool (const bool i, const Path &p)=0
 
virtual ReturnType writeDict (const std::map< std::string, ReturnType > &elements, const std::optional< ReturnType > &extends, const Path &p)=0
 
virtual ReturnType writeDouble (const double i, const Path &p)=0
 
virtual ReturnType writeFloat (const float i, const Path &p)=0
 
virtual ReturnType writeInt (const int i, const Path &p)=0
 
virtual ReturnType writeList (const std::vector< ReturnType > &elements, const Path &p)=0
 
virtual ReturnType writeLong (const long i, const Path &p)=0
 
virtual ReturnType writeNDArray (const std::vector< int > &shape, const std::string &typeAsString, const unsigned char *data, const Path &p)=0
 
virtual ReturnType writeNull ()
 
ReturnType writePrimitive (const bool i, const Path &p=Path())
 
ReturnType writePrimitive (const double i, const Path &p=Path())
 
ReturnType writePrimitive (const float i, const Path &p=Path())
 
ReturnType writePrimitive (const int i, const Path &p=Path())
 
ReturnType writePrimitive (const long i, const Path &p=Path())
 
ReturnType writePrimitive (const std::string &i, const Path &p=Path())
 
virtual ReturnType writeString (const std::string &i, const Path &p)=0
 
virtual ~WriterInterface ()=default
 

Detailed Description

template<class R>
class armarx::aron::data::WriterInterface< R >

Definition at line 38 of file Writer.h.

Member Typedef Documentation

◆ ReturnType

using ReturnType = R

Definition at line 41 of file Writer.h.

◆ ReturnTypeConst

using ReturnTypeConst = typename std::add_const<ReturnType>::type

Definition at line 42 of file Writer.h.

Constructor & Destructor Documentation

◆ ~WriterInterface()

virtual ~WriterInterface ( )
virtualdefault

Member Function Documentation

◆ getDescriptor()

virtual data::Descriptor getDescriptor ( ReturnTypeConst &  input)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

◆ writeBool()

virtual ReturnType writeBool ( const bool  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:

◆ writeDict()

virtual ReturnType writeDict ( const std::map< std::string, ReturnType > &  elements,
const std::optional< ReturnType > &  extends,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter.

◆ writeDouble()

virtual ReturnType writeDouble ( const double  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:

◆ writeFloat()

virtual ReturnType writeFloat ( const float  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:

◆ writeInt()

virtual ReturnType writeInt ( const int  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:

◆ writeList()

virtual ReturnType writeList ( const std::vector< ReturnType > &  elements,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

◆ writeLong()

virtual ReturnType writeLong ( const long  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:

◆ writeNDArray()

virtual ReturnType writeNDArray ( const std::vector< int > &  shape,
const std::string &  typeAsString,
const unsigned char *  data,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

◆ writeNull()

virtual ReturnType writeNull ( )
inlinevirtual

Definition at line 60 of file Writer.h.

◆ writePrimitive() [1/6]

ReturnType writePrimitive ( const bool  i,
const Path &  p = Path() 
)
inline

Definition at line 91 of file Writer.h.

◆ writePrimitive() [2/6]

ReturnType writePrimitive ( const double  i,
const Path &  p = Path() 
)
inline

Definition at line 81 of file Writer.h.

◆ writePrimitive() [3/6]

ReturnType writePrimitive ( const float  i,
const Path &  p = Path() 
)
inline

Definition at line 76 of file Writer.h.

◆ writePrimitive() [4/6]

ReturnType writePrimitive ( const int  i,
const Path &  p = Path() 
)
inline

Definition at line 66 of file Writer.h.

◆ writePrimitive() [5/6]

ReturnType writePrimitive ( const long  i,
const Path &  p = Path() 
)
inline

Definition at line 71 of file Writer.h.

◆ writePrimitive() [6/6]

ReturnType writePrimitive ( const std::string &  i,
const Path &  p = Path() 
)
inline

Definition at line 86 of file Writer.h.

◆ writeString()

virtual ReturnType writeString ( const std::string &  i,
const Path &  p 
)
pure virtual

Implemented in NlohmannJSONWriter, and VariantWriter.

+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: