DtAsciiSerializable Class Reference

Inheritance diagram for DtAsciiSerializable:

Public Member Functions
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual DtString	objectType () const =0
	Should return the string name of this object.
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType.
virtual DtString	serialize ()=0
	The following characters are reserved and cannot be used in serialization: '|', ':'.
virtual bool	deserialize (const DtString &)=0
	This function should take the string that was serialized via serialize() and fill this object with the correct data.
virtual void	init (void *userData)
	This function is called right after the object is constructed during the deserialization process, but before deserialize() is called.

Additional Inherited Members
Static Public Member Functions inherited from DtObjectDebugger< DtAsciiSerializable >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Protected Member Functions inherited from DtObjectDebugger< DtAsciiSerializable >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Constructor & Destructor Documentation

DtAsciiSerializable::DtAsciiSerializable ( )

inline

The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.

DtAsciiSerializable::DtAsciiSerializable ( const DtAsciiSerializable &  orig )

inline

virtual DtAsciiSerializable::~DtAsciiSerializable ( )

inlinevirtual

Member Function Documentation

virtual DtString DtAsciiSerializable::objectType ( ) const

pure virtual

Should return the string name of this object.

The object name should not be part of the serialization unless you want it to be, but you should take it into account when implementing both functions.

Implemented in DtVectorOffset3D, DtVectorGeoc3D, DtVector2D, DtScriptVrfObject, DtVector3D, DtScriptAnimationModel, DtScriptComponentSystem, DtTranslatableStream, DtLuaPathJob, DtLuaFeatureSet, and DtLocation3D.

Referenced by vrfLua::DtAsciiDeserializeLua().

virtual std::string DtAsciiSerializable::objectTypeC ( ) const

inlinevirtual

Returns a std::string version of the objectType.

This is used in the Lua API.

virtual DtString DtAsciiSerializable::serialize ( )

pure virtual

The following characters are reserved and cannot be used in serialization: '|', ':'.

Implemented in DtVectorOffset3D, DtVectorGeoc3D, DtScriptVrfObject, DtVector3D, DtScriptAnimationModel, DtTranslatableStream, DtScriptComponentSystem, DtLuaPathJob, DtLuaFeatureSet, and DtLocation3D.

virtual bool DtAsciiSerializable::deserialize ( const DtString &  )

pure virtual

This function should take the string that was serialized via serialize() and fill this object with the correct data.

Implemented in DtVectorOffset3D, DtVectorGeoc3D, DtScriptVrfObject, DtVector3D, DtScriptAnimationModel, DtScriptComponentSystem, DtTranslatableStream, DtLuaFeatureSet, DtLuaPathJob, and DtLocation3D.

Referenced by vrfLua::DtAsciiDeserializeLua().

virtual void DtAsciiSerializable::init ( void *  userData )

inlinevirtual

This function is called right after the object is constructed during the deserialization process, but before deserialize() is called.

The Lua object deserializer will pass the address of the sim manager (DtSimManager) as the argument. This DtAsciiSerializable object can use the Sim Manager to get a VRF Object pointer from the object manager using the object name, for example.

Reimplemented in DtScriptComponentSystem, DtScriptAnimationModel, and DtLuaAsyncJob.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/asciiSerializable.h