RobWorkProject  21.8.23-
Public Member Functions | List of all members
Serializable Class Referenceabstract

interface for defining serialization of classes. If a class cannot inherit the Serializable because of non-access to code then one can instead provide overloaded read/write methods to perform the serialization. More...

#include <Serializable.hpp>

Inherited by KDTreeQ< Node >, State, KDTreeQ< VALUE_TYPE >, Contact, and SimulatorLog.

Public Member Functions

virtual ~Serializable ()
 destructor
 
virtual void read (class InputArchive &iarchive, const std::string &id)=0
 
virtual void write (class OutputArchive &oarchive, const std::string &id) const =0
 

Detailed Description

interface for defining serialization of classes. If a class cannot inherit the Serializable because of non-access to code then one can instead provide overloaded read/write methods to perform the serialization.

Member Function Documentation

◆ read()

virtual void read ( class InputArchive iarchive,
const std::string &  id 
)
pure virtual

Enable read-serialization of inherited class by implementing this method. Data is read from iarchive and filled into this object.

Parameters
iarchive[in] the InputArchive from which to read data.
id[in] The id of the serialized sobject.
Note
the id can be empty in which case the overloaded method should provide a default identifier. E.g. the Vector3D class defined "Vector3D" as its default id.

Implemented in KDTreeQ< VALUE_TYPE >, KDTreeQ< Node >, State, Contact, SimulatorLogEntry, SimulatorLog, SimulatorLogScope, LogDistanceMultiResult, LogDistanceResult, LogEquationSystem, LogCollisionResult, LogContactVelocities, LogVelocities, LogConstraints, LogStep, LogContactSet, LogForceTorque, LogPositions, LogMessage, and LogValues.

◆ write()

virtual void write ( class OutputArchive oarchive,
const std::string &  id 
) const
pure virtual

Enable write-serialization of inherited class by implementing this method. Data is written to oarchive from this object.

Parameters
oarchive[out] the OutputArchive in which data should be written.
id[in] The id of the serialized sobject.
Note
the id can be empty in which case the overloaded method should provide a default identifier. E.g. the Vector3D class defined "Vector3D" as its default id.

Implemented in KDTreeQ< VALUE_TYPE >, KDTreeQ< Node >, State, Contact, SimulatorLogEntry, SimulatorLog, SimulatorLogScope, LogDistanceMultiResult, LogDistanceResult, LogEquationSystem, LogCollisionResult, LogContactVelocities, LogVelocities, LogConstraints, LogStep, LogContactSet, LogForceTorque, LogPositions, LogMessage, and LogValues.


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