ARGoS 3
A parallel, multi-engine simulator for swarm robotics
Public Member Functions | List of all members
argos::CMemento Class Referenceabstract

The interface inherited by all classes whose state must be saved and restored. More...

#include <memento.h>

Public Member Functions

virtual ~CMemento ()
 Class destructor.
 
virtual void SaveState (CByteArray &c_buffer)=0
 Saves the state of the object to the given buffer.
 
virtual void LoadState (CByteArray &c_buffer)=0
 Restores the state of the object from the given buffer.
 

Detailed Description

The interface inherited by all classes whose state must be saved and restored.

Definition at line 27 of file memento.h.

Constructor & Destructor Documentation

◆ ~CMemento()

virtual argos::CMemento::~CMemento ( )
inlinevirtual

Class destructor.

Definition at line 34 of file memento.h.

Member Function Documentation

◆ LoadState()

virtual void argos::CMemento::LoadState ( CByteArray & c_buffer)
pure virtual

Restores the state of the object from the given buffer.

The read data is removed from the buffer.

Parameters
c_bufferthe source buffer

◆ SaveState()

virtual void argos::CMemento::SaveState ( CByteArray & c_buffer)
pure virtual

Saves the state of the object to the given buffer.

Data is added to the buffer.

Parameters
c_bufferthe target buffer
The documentation for this class was generated from the following file: