Classes | Functions
pinocchio::serialization Namespace Reference

Classes

struct  Serializable
 
struct  StaticBuffer
 Static buffer with pre-allocated memory. More...
 

Functions

template<typename T >
void loadFromBinary (T &object, const std::string &filename)
 Loads an object from a binary file. More...
 
template<typename T >
void loadFromBinary (T &object, boost::asio::streambuf &buffer)
 Loads an object from a binary buffer. More...
 
template<typename T >
void loadFromBinary (T &object, StaticBuffer &buffer)
 Loads an object from a static binary buffer. The buffer should be of a sufficient size. More...
 
template<typename T >
void loadFromString (T &object, const std::string &str)
 Loads an object from a std::string. More...
 
template<typename T >
void loadFromStringStream (T &object, std::istringstream &is)
 Loads an object from a std::stringstream. More...
 
template<typename T >
void loadFromText (T &object, const std::string &filename)
 Loads an object from a TXT file. More...
 
template<typename T >
void loadFromXML (T &object, const std::string &filename, const std::string &tag_name)
 Loads an object from a XML file. More...
 
template<typename T >
void saveToBinary (const T &object, const std::string &filename)
 Saves an object inside a binary file. More...
 
template<typename T >
void saveToBinary (const T &object, boost::asio::streambuf &buffer)
 Saves an object to a binary buffer. More...
 
template<typename T >
void saveToBinary (const T &object, StaticBuffer &buffer)
 Saves an object to a static binary buffer. The buffer should be of a sufficient size. More...
 
template<typename T >
std::string saveToString (const T &object)
 Saves an object inside a std::string. More...
 
template<typename T >
void saveToStringStream (const T &object, std::stringstream &ss)
 Saves an object inside a std::stringstream. More...
 
template<typename T >
void saveToText (const T &object, const std::string &filename)
 Saves an object inside a TXT file. More...
 
template<typename T >
void saveToXML (const T &object, const std::string &filename, const std::string &tag_name)
 Saves an object inside a XML file. More...
 

Function Documentation

◆ loadFromBinary() [1/3]

template<typename T >
void pinocchio::serialization::loadFromBinary ( T &  object,
const std::string &  filename 
)
inline

Loads an object from a binary file.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.

Definition at line 238 of file archive.hpp.

◆ loadFromBinary() [2/3]

template<typename T >
void pinocchio::serialization::loadFromBinary ( T &  object,
boost::asio::streambuf &  buffer 
)
inline

Loads an object from a binary buffer.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]bufferInput buffer containing the serialized data.

Definition at line 288 of file archive.hpp.

◆ loadFromBinary() [3/3]

template<typename T >
void pinocchio::serialization::loadFromBinary ( T &  object,
StaticBuffer buffer 
)
inline

Loads an object from a static binary buffer. The buffer should be of a sufficient size.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]bufferInput buffer containing the serialized data.

Definition at line 321 of file archive.hpp.

◆ loadFromString()

template<typename T >
void pinocchio::serialization::loadFromString ( T &  object,
const std::string &  str 
)
inline

Loads an object from a std::string.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]strstring constaining the serialized content of the object.

Definition at line 145 of file archive.hpp.

◆ loadFromStringStream()

template<typename T >
void pinocchio::serialization::loadFromStringStream ( T &  object,
std::istringstream &  is 
)
inline

Loads an object from a std::stringstream.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]isstring stream constaining the serialized content of the object.

Definition at line 113 of file archive.hpp.

◆ loadFromText()

template<typename T >
void pinocchio::serialization::loadFromText ( T &  object,
const std::string &  filename 
)
inline

Loads an object from a TXT file.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.

Definition at line 61 of file archive.hpp.

◆ loadFromXML()

template<typename T >
void pinocchio::serialization::loadFromXML ( T &  object,
const std::string &  filename,
const std::string &  tag_name 
)
inline

Loads an object from a XML file.

Template Parameters
TType of the object to deserialize.
Parameters
[out]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.
[in]tag_nameXML Tag for the given object.

Definition at line 179 of file archive.hpp.

◆ saveToBinary() [1/3]

template<typename T >
void pinocchio::serialization::saveToBinary ( const T &  object,
const std::string &  filename 
)

Saves an object inside a binary file.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.

Definition at line 263 of file archive.hpp.

◆ saveToBinary() [2/3]

template<typename T >
void pinocchio::serialization::saveToBinary ( const T &  object,
boost::asio::streambuf &  buffer 
)

Saves an object to a binary buffer.

Template Parameters
TType of the object to serialize.
Parameters
[in]objectObject in which the loaded data are copied.
[out]bufferOutput buffer containing the serialized data.

Definition at line 304 of file archive.hpp.

◆ saveToBinary() [3/3]

template<typename T >
void pinocchio::serialization::saveToBinary ( const T &  object,
StaticBuffer buffer 
)
inline

Saves an object to a static binary buffer. The buffer should be of a sufficient size.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
[out]bufferOutput buffer containing the serialized data.

Definition at line 340 of file archive.hpp.

◆ saveToString()

template<typename T >
std::string pinocchio::serialization::saveToString ( const T &  object)
inline

Saves an object inside a std::string.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
Returns
a string constaining the serialized content of the object.

Definition at line 162 of file archive.hpp.

◆ saveToStringStream()

template<typename T >
void pinocchio::serialization::saveToStringStream ( const T &  object,
std::stringstream &  ss 
)
inline

Saves an object inside a std::stringstream.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
[out]ssString stream constaining the serialized content of the object.

Definition at line 129 of file archive.hpp.

◆ saveToText()

template<typename T >
void pinocchio::serialization::saveToText ( const T &  object,
const std::string &  filename 
)
inline

Saves an object inside a TXT file.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.

Definition at line 88 of file archive.hpp.

◆ saveToXML()

template<typename T >
void pinocchio::serialization::saveToXML ( const T &  object,
const std::string &  filename,
const std::string &  tag_name 
)
inline

Saves an object inside a XML file.

Template Parameters
TType of the object to deserialize.
Parameters
[in]objectObject in which the loaded data are copied.
[in]filenameName of the file containing the serialized data.
[in]tag_nameXML Tag for the given object.

Definition at line 210 of file archive.hpp.



pinocchio
Author(s):
autogenerated on Fri Jun 23 2023 02:38:36