AGX Dynamics 2.37.3.3
|
This namespace contain classes for streaming classes into archives, ASCII, binary for storage (serialization). More...
Namespaces | |
namespace | ElementTypes |
Classes | |
class | Archive |
Abstract base class for input/output storage of Serializable classes. More... | |
class | ArchiveEofException |
class | ArchiveException |
struct | ClassInformation |
Class that extracts namespace, class name and method name when called with the AGX_FUNCTION macro. More... | |
class | EndOfArchiveException |
class | InputArchive |
Class for reading a binary stream of serialized data. More... | |
struct | InputRef |
struct | InputVal |
class | OutputArchive |
Class for writing serialized data in binary format to a stream. More... | |
struct | OutputRef |
struct | OutputVal |
class | RestoreListener |
Class for listening to the restore of Serializable objects. More... | |
class | RestoreObjects |
class | Serializable |
This class is an abstract base class for all classes that can be stored and retrieved from an Archive. More... | |
class | SerializablePtrVector |
class | StorageStream |
Abstract base class for storing/restoring a line/drums with version control. More... | |
class | StoreObjects |
class | XMLInputArchive |
XML version of an input archive for restoring data written with the XMLOutputArchive. More... | |
class | XMLOutputArchive |
XML version of an OutputArchive (for storing serialized objects). More... | |
Typedefs | |
typedef agx::ref_ptr< Archive > | ArchiveRef |
typedef agx::ref_ptr< InputArchive > | InputArchiveRef |
typedef agx::ref_ptr< OutputArchive > | OutputArchiveRef |
typedef agx::ref_ptr< RestoreListener > | RestoreListenerRef |
typedef agx::ref_ptr< XMLInputArchive > | XMLInputArchiveRef |
typedef agx::ref_ptr< XMLOutputArchive > | XMLOutputArchiveRef |
Enumerations | |
enum | HeaderTag { OBJECT_TAG = 0x1 , CLASS_TAG = 0x2 } |
enum | StorageMode { STORE_BY_VALUE = 0x4 , STORE_BY_REF = 0x8 , STORE_NULL_POINTER = 0x10 } |
Variables | |
const agx::UInt32 | ARCHIVE_MAGIC = 0xFADDED0 |
magic number for archives | |
const agx::UInt16 | STORAGESTREAM_VERSION_AMOR_PARALLELIZATION = 4 |
const agx::UInt16 | STORAGESTREAM_VERSION_COMBUSTION_ENGINE = 6 |
const agx::UInt16 | STORAGESTREAM_VERSION_COMBUSTION_ENGINE_STABILITY_FIX = 9 |
const agx::UInt16 | STORAGESTREAM_VERSION_COMBUSTION_ENGINE_STARTER = 8 |
const agx::UInt16 | STORAGESTREAM_VERSION_CONSTRAINT_ATTACHMENTS = 3 |
const agx::UInt16 | STORAGESTREAM_VERSION_ELECTRIC_MOTOR = 5 |
const agx::UInt16 | STORAGESTREAM_VERSION_FRICTION_CONTROLLER = 7 |
const agx::UInt16 | STORAGESTREAM_VERSION_FRICTION_CONTROLLER_STATIC_FORCE = 11 |
const agx::UInt16 | STORAGESTREAM_VERSION_HINGE_SWING = 1 |
const agx::UInt16 | STORAGESTREAM_VERSION_INDEXSET_STATE = 2 |
const agx::UInt16 | STORAGESTREAM_VERSION_LINEARIZATION_ON_CONSTRAINT = 12 |
const agx::UInt16 | STORAGESTREAM_VERSION_NEW_TORQUE_CONVERTER = 10 |
This namespace contain classes for streaming classes into archives, ASCII, binary for storage (serialization).
typedef agx::ref_ptr<Archive> agxStream::ArchiveRef |
Definition at line 354 of file InputArchive.h.
Definition at line 343 of file OutputArchive.h.
Definition at line 45 of file RestoreListener.h.
Definition at line 142 of file XMLInputArchive.h.
Definition at line 143 of file XMLOutputArchive.h.
enum agxStream::HeaderTag |
InputRef< T > agxStream::in | ( | const char * | name, |
T & | obj | ||
) |
Create an object with a name and a reference to the object that should be restored (usually a pointer).
This should be used for restoring pointers to Serializable objects.
name | - name of the object requested to be restored. |
obj | - reference to the object to be restored |
Definition at line 400 of file InputArchive.h.
Referenced by agxStream::RestoreObjects< T >::RestoreObjects(), operator>>(), agxModel::Deformable1DRadiusGeometryFactory< T >::restore(), restoreObserverPtr(), and restoreRefPtr().
InputVal< T > agxStream::in_val | ( | const char * | name, |
T & | obj | ||
) |
Create an object with a name and a reference to the object that should be restored.
This should be used for restoring by value. For double, float, Vec3 and references to Serializable objects.
name | - name of the object requested to be restored. |
obj | - reference to the object to be restored |
Definition at line 411 of file InputArchive.h.
|
inline |
Definition at line 428 of file OutputArchive.h.
References agxStream::OutputRef< T >::m_mode, agxStream::OutputRef< T >::m_name, agxStream::OutputRef< T >::m_obj, and out().
|
inline |
Definition at line 437 of file OutputArchive.h.
References agxStream::OutputVal< T >::m_name, agxStream::OutputVal< T >::m_obj, and out().
AGXPHYSICS_EXPORT std::ostream & agxStream::operator<< | ( | std::ostream & | str, |
StorageStream & | storage | ||
) |
|
inline |
Definition at line 545 of file StorageStream.h.
References out().
|
inline |
Definition at line 539 of file StorageStream.h.
References out().
|
inline |
Definition at line 558 of file StorageStream.h.
References out().
|
inline |
Definition at line 552 of file StorageStream.h.
References out().
|
inline |
Definition at line 621 of file StorageStream.h.
References out().
|
inline |
Definition at line 615 of file StorageStream.h.
References out().
|
inline |
Definition at line 645 of file StorageStream.h.
References out().
|
inline |
Definition at line 639 of file StorageStream.h.
References out().
|
inline |
Definition at line 603 of file StorageStream.h.
References out().
|
inline |
Definition at line 627 of file StorageStream.h.
References out().
|
inline |
Definition at line 633 of file StorageStream.h.
References out().
|
inline |
Definition at line 609 of file StorageStream.h.
References out().
|
inline |
Definition at line 651 of file StorageStream.h.
References out().
|
inline |
Definition at line 597 of file StorageStream.h.
References out().
|
inline |
Definition at line 591 of file StorageStream.h.
References out().
|
inline |
Definition at line 585 of file StorageStream.h.
References out().
|
inline |
Definition at line 565 of file StorageStream.h.
References out().
|
inline |
Definition at line 571 of file StorageStream.h.
References out().
|
inline |
Definition at line 470 of file InputArchive.h.
References in(), agxStream::InputRef< T >::m_mode, agxStream::InputRef< T >::m_name, and agxStream::InputRef< T >::m_obj.
|
inline |
Definition at line 462 of file InputArchive.h.
References in(), agxStream::InputVal< T >::m_mode, agxStream::InputVal< T >::m_name, and agxStream::InputVal< T >::m_obj.
AGXPHYSICS_EXPORT std::istream & agxStream::operator>> | ( | std::istream & | str, |
StorageStream & | storage | ||
) |
|
inline |
Definition at line 520 of file StorageStream.h.
References in().
|
inline |
Definition at line 526 of file StorageStream.h.
References in().
|
inline |
Definition at line 514 of file StorageStream.h.
References in().
|
inline |
Definition at line 508 of file StorageStream.h.
References in().
|
inline |
Definition at line 484 of file StorageStream.h.
References in().
|
inline |
Definition at line 422 of file StorageStream.h.
References in().
|
inline |
Definition at line 416 of file StorageStream.h.
References in().
|
inline |
Definition at line 496 of file StorageStream.h.
References in().
|
inline |
Definition at line 502 of file StorageStream.h.
References in().
|
inline |
Definition at line 490 of file StorageStream.h.
References in().
|
inline |
Definition at line 532 of file StorageStream.h.
References in().
|
inline |
Definition at line 434 of file StorageStream.h.
References in().
|
inline |
Definition at line 428 of file StorageStream.h.
References in().
|
inline |
Definition at line 472 of file StorageStream.h.
References in().
|
inline |
Definition at line 466 of file StorageStream.h.
References in().
|
inline |
Definition at line 440 of file StorageStream.h.
References in().
|
inline |
Definition at line 448 of file StorageStream.h.
References in().
|
inline |
Definition at line 478 of file StorageStream.h.
References in().
|
inline |
Return an object that contain the name and the object that should be serialized to an archive.
This should be used for pointers to Serializable objects.
name | - name of the object/data |
obj | - Pointer to a Serializable object |
Definition at line 412 of file OutputArchive.h.
References STORE_BY_REF.
Referenced by agxStream::StoreObjects< T >::~StoreObjects(), operator<<(), and agxModel::Deformable1DRadiusGeometryFactory< T >::store().
OutputRef< T > agxStream::out_val | ( | const char * | name, |
const T & | obj | ||
) |
Return an object that contain the name and the object that should be serialized to an archive.
This should be used for serializing objects by value.
name | - name of the object/data |
obj | - Reference to a Serializable object or a basic type (double, Vec3, RangeReal etc.) |
Definition at line 424 of file OutputArchive.h.
References STORE_BY_VALUE.
bool AGXPHYSICS_EXPORT agxStream::read | ( | const std::string & | filename, |
agxStream::SerializablePtrVector & | readObjects | ||
) |
Open and read serializable objects from a file on disk with previously stored objects.
The type of file (binary/ascii) is determined from the file type.
The vector readObjects
contain pointers to restored objects, and it is the caller of this functions responsibility to handle the allocated memory.
filename | - The exact path to the file where data will be written, it will not be searched for using agxIO::Environment. |
readObjects | - Vector containing pointers to restored objects. |
Referenced by agxStream::InputArchive::read().
void agxStream::restoreObserverPtr | ( | agxStream::InputArchive & | in, |
const char * | name, | ||
agx::observer_ptr< T > & | observerPtr | ||
) |
Definition at line 489 of file InputArchive.h.
References in().
void agxStream::restoreRefPtr | ( | agxStream::InputArchive & | in, |
const char * | name, | ||
agx::ref_ptr< T > & | refPtr | ||
) |
Definition at line 481 of file InputArchive.h.
References in().
bool AGXPHYSICS_EXPORT agxStream::write | ( | const std::string & | filename, |
const agxStream::Serializable * | data | ||
) |
Write a Serializable object to a file.
The type of file (binary/ascii) is determined from the file type.
filename | - The path to the file where data will be param. |
data | - Pointer to the serializable data that will be stored. |
Referenced by agxStream::OutputArchive::write().
bool AGXPHYSICS_EXPORT agxStream::write | ( | const std::string & | filename, |
const agxStream::SerializablePtrVector & | writeObjects | ||
) |
Write a Serializable object to a file.
The type of file (binary/ascii) is determined from the file type.
filename | - The path to the file where data will be written. |
writeObjects | - Vector containing pointers to serializable objects that will be stored. |
const agx::UInt32 agxStream::ARCHIVE_MAGIC = 0xFADDED0 |
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_AMOR_PARALLELIZATION = 4 |
Definition at line 27 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_COMBUSTION_ENGINE = 6 |
Definition at line 29 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_COMBUSTION_ENGINE_STABILITY_FIX = 9 |
Definition at line 32 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_COMBUSTION_ENGINE_STARTER = 8 |
Definition at line 31 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_CONSTRAINT_ATTACHMENTS = 3 |
Definition at line 26 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_ELECTRIC_MOTOR = 5 |
Definition at line 28 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_FRICTION_CONTROLLER = 7 |
Definition at line 30 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_FRICTION_CONTROLLER_STATIC_FORCE = 11 |
Definition at line 34 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_HINGE_SWING = 1 |
Definition at line 24 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_INDEXSET_STATE = 2 |
Definition at line 25 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_LINEARIZATION_ON_CONSTRAINT = 12 |
Definition at line 35 of file StorageStreamVersions.h.
const agx::UInt16 agxStream::STORAGESTREAM_VERSION_NEW_TORQUE_CONVERTER = 10 |
Definition at line 33 of file StorageStreamVersions.h.