BaseType Class Reference

#include <BaseType.h>

Inherited by PackFloat, PackLong, PackString, PackStruct, PackTreeCell, and PackULong.

Detailed Description

Virtual class for all AzurVeda serializable types. It is the root of all serializable classes, and actually all classes in AzurVeda Inherit from it.

All inherited objects will be able to read their values with Serialize_In(), and write it to a first call to GetSerializedDescriptionSize(), which return the size of the data to write, and then Serialize_Out() that writes it. In editable mode, each objects has direct access to ReadFile() and WriteFile() which uses the serialization.

AzurVeda Also provide a more complex Context management, through classes BaseContext and BaseObject : a BaseContext object manages a set of BaseObject. Simple BaseType are then used as class members of BaseObjects. That's why this class is also able to tell if it is a baseObject member with GetObjectThatManagesThis() , and implements methods for BaseContext edition notification.

Definition at line 38 of file BaseType.h.

Public Types

enum eVedaUpdate {
  eVedaUpdate_NoUpdate = 0, eVedaUpdate_MemberIsGoingToChange, eVedaUpdate_MemberChanged, eVedaUpdate_MemberChangedBecauseOfUndo,
  eVedaUpdate_MemberDestroyed, eVedaUpdate_ObjectNew, eVedaUpdate_ObjectDestroyed, eVedaUpdate_ObjectReCreated,
  eVedaUpdate_ObjectClosed, eVedaUpdate_NewRegisteredClass
}

enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context. More...

Public Member Functions

BaseType (void)

Constructor.

virtual ~BaseType (void)

Destructor.

virtual const unsigned char * Serialize_In (const unsigned char *_pDescriptionChunk)=0

Read the object description from a byte chunk. Could crash if chunk not valid.

virtual unsigned int GetSerializedDescriptionSize (void)=0

get the size of the whole byte chunk that will be written by Serialize_Out().

virtual unsigned char * Serialize_Out (unsigned char *_pDescriptionChunkToFill)=0

write the Current object definition to a Chunk using private packed types, recursively.

virtual unsigned int WriteFile (const char *_pFileName)

write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().

virtual unsigned int ReadFile (const char *_pFileName)

Try to read a serialized form, using Serialize_In().

virtual void SetObjectThatManagesThis (BaseObject *_pManager)

The Object this one belong to as a member. Should only be used at init.

void SetMemberName (const char *_MemberName)

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).

const char * GetMemberName () const

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().

void SetMemberInfo (const char *_MemberInfo)

Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.

const char * GetMemberInfo () const

Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.

virtual const char * GetClassID () const =0

Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.

virtual const char * ValueToString ()

convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods.

BaseObject * GetObjectThatManagesThis ()

If there is any, get the object that manages this one as a member.

void MakeCloneOf (BaseType &_ModelObject)

Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().

Protected Member Functions

void BeginChangeNotification ()

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

void EndChangeNotification ()

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

Protected Attributes

BaseObject * m_pObjectThatManagesThis

an object can belong (or not) to a BaseObject,( and to a BaseContext through it).

const char * m_pMemberName

If used as a member in an object, the member name, or NULL (not editable member).

const char * m_pMemberInfo

a short string explaining what's the object for in editable mode. OK if NULL (no info).

PackString * m_pValueString

a string standing for an expression of the value of the object:

unsigned char * m_pPreviousValueShape

used as a temp for object change notification in Begin/EndChangeNotification():

unsigned int m_PreviousValueShapeLength

Classes

class ObjectManager

Nested Class that manages events (TODO,When final, this will give more independances between Base types and Context class). More...

Member Enumeration Documentation

enum eVedaUpdate

enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context.

Enumerator:

eVedaUpdate_NoUpdate 0 means No Update.

eVedaUpdate_MemberIsGoingToChange Sent before a BaseObject member value change.( in order to lock the context to prevent object use from other thread.).

eVedaUpdate_MemberChanged a member of a BaseObject just changed.

eVedaUpdate_MemberChangedBecauseOfUndo a member of a BaseObject just changed, but because of an undo. you may treat it the same as eVedaUpdate_MemberChanged.

eVedaUpdate_MemberDestroyed Member of object Destroyed ! Watch out, the ID of the member is a dead pointer.

eVedaUpdate_ObjectNew new BaseObject created.

eVedaUpdate_ObjectDestroyed BaseObject just destroyed.Watch out, the ID of the object is a dead pointer.

eVedaUpdate_ObjectReCreated an object has just been Created; It's state has changed!

eVedaUpdate_ObjectClosed an object has just been closed; It's state has changed!

eVedaUpdate_NewRegisteredClass TODO: a new class has been registered to the context.

Definition at line 194 of file BaseType.h.

Constructor & Destructor Documentation

BaseType ( void )

Constructor.

virtual ~BaseType ( void ) [virtual]

Destructor.

Member Function Documentation

void BeginChangeNotification ( ) [protected]

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

void EndChangeNotification ( ) [protected]

In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.

virtual const char* GetClassID ( ) const [pure virtual]

Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.

Returns:
a const character string, that must be unique and unchanged for all serializable base type.

Implemented in BaseContext, BaseObject, ClassNode, PackDynamicType, PackFloat, PackFloat_FixedPoint, PackFloatByte_Color, PackFloatByte_Limits, PackList, PackList_TimeBlockTrack, PackList_TimeTrack, PackLong, PackLong_WithLimits, PackObjectReference, PackResource, PackString, PackString_MultipleLines, PackStruct, PackTreeCell, PackULong, PackULong_Enums, and PackULong_Flags.

const char* GetMemberInfo ( ) const [inline]

Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.

Returns:
a short string explaining what's the object for, or NULL if not set.

Definition at line 144 of file BaseType.h.
References m_pMemberInfo.

const char* GetMemberName ( ) const [inline]

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().

Returns:
the member name or NULL

Definition at line 123 of file BaseType.h.
References m_pMemberName.

BaseObject* GetObjectThatManagesThis ( ) [inline]

If there is any, get the object that manages this one as a member.

Returns:
the object that manages this one as a member, or NULL

Definition at line 170 of file BaseType.h.
References m_pObjectThatManagesThis.

virtual unsigned int GetSerializedDescriptionSize ( void ) [pure virtual]

get the size of the whole byte chunk that will be written by Serialize_Out().

Returns:
byte size of the serialisation to do.

Implemented in BaseContext, ClassNode, InterfacePrefObject, NamedObject, PackDynamicType, PackFloat, PackFloat_FixedPoint, PackFloatByte_Limits, PackList, PackLong, PackObjectReference, PackResource, PackString, PackStruct, PackTreeCell, and PackULong.

void MakeCloneOf ( BaseType & _ModelObject )

Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().

Parameters:

_ModelObject the object took as a model.

virtual unsigned int ReadFile ( const char * _pFileName ) [virtual]

Try to read a serialized form, using Serialize_In().

Parameters:

_pFileName the file path.

Returns:
0 if OK.

virtual const unsigned char* Serialize_In ( const unsigned char * _pDescriptionChunk ) [pure virtual]

Read the object description from a byte chunk. Could crash if chunk not valid.

Parameters:

_pDescriptionChunk the objet description chunk.

Returns:
the end of the chunk written, possibly unlocated. Don't use this if you don't need it.

Implemented in BaseContext, ClassNode, NamedObject, PackDynamicType, PackFloat, PackFloat_FixedPoint, PackFloatByte_Limits, PackList, PackList_TimeTrack, PackLong, PackResource, PackString, PackStruct, PackTreeCell, and PackULong.

virtual unsigned char* Serialize_Out ( unsigned char * _pDescriptionChunkToFill ) [pure virtual]

write the Current object definition to a Chunk using private packed types, recursively.

Parameters:

_pDescriptionChunkToFill the chunk where to write the objet description chunk.

Returns:
the end of the chunk written, possibly unlocated. Don't use this if you don't need it.

Implemented in BaseContext, ClassNode, NamedObject, PackDynamicType, PackFloat, PackFloat_FixedPoint, PackFloatByte_Limits, PackList, PackLong, PackObjectReference, PackResource, PackString, PackStruct, PackTreeCell, and PackULong.

void SetMemberInfo ( const char * _MemberInfo )

Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.

Parameters:

_MemberName a short string explaining what's the object for.

void SetMemberName ( const char * _MemberName )

Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).

Parameters:

_MemberName the member name

virtual void SetObjectThatManagesThis ( BaseObject * _pManager ) [virtual]

The Object this one belong to as a member. Should only be used at init.

Parameters:

_pManager BaseObject

Reimplemented in PackObjectReference, PackResource, PackStruct, and PackTreeCell.

virtual const char* ValueToString ( ) [virtual]

convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods.

Returns:
the value as a const string.

Reimplemented in PackDynamicType, PackFloat, PackLong, PackObjectReference, PackString, PackStruct, PackULong, PackULong_Enums, and PackULong_Flags.

virtual unsigned int WriteFile ( const char * _pFileName ) [virtual]

write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().

Parameters:

_pFileName the file path.

Returns:
0 if OK.

Member Data Documentation

const char* m_pMemberInfo [protected]

a short string explaining what's the object for in editable mode. OK if NULL (no info).

Definition at line 259 of file BaseType.h.
Referenced by GetMemberInfo().

const char* m_pMemberName [protected]

If used as a member in an object, the member name, or NULL (not editable member).

Definition at line 255 of file BaseType.h.
Referenced by GetMemberName().

BaseObject* m_pObjectThatManagesThis [protected]

an object can belong (or not) to a BaseObject,( and to a BaseContext through it).

Definition at line 251 of file BaseType.h.
Referenced by GetObjectThatManagesThis().

unsigned char* m_pPreviousValueShape [protected]

used as a temp for object change notification in Begin/EndChangeNotification():

Definition at line 269 of file BaseType.h.

PackString* m_pValueString [protected]

a string standing for an expression of the value of the object:

Definition at line 264 of file BaseType.h.

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

Veda/BaseType.h

      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/


Public Types
enum	eVedaUpdate { eVedaUpdate_NoUpdate = 0, eVedaUpdate_MemberIsGoingToChange, eVedaUpdate_MemberChanged, eVedaUpdate_MemberChangedBecauseOfUndo, eVedaUpdate_MemberDestroyed, eVedaUpdate_ObjectNew, eVedaUpdate_ObjectDestroyed, eVedaUpdate_ObjectReCreated, eVedaUpdate_ObjectClosed, eVedaUpdate_NewRegisteredClass }
	enum used by BaseContext::NotifyObjectChange() to describe the notification meaning. Used by interfaces to monitor a context. More...
Public Member Functions
	BaseType (void)
	Constructor.
virtual	~BaseType (void)
	Destructor.
virtual const unsigned char *	Serialize_In (const unsigned char *_pDescriptionChunk)=0
	Read the object description from a byte chunk. Could crash if chunk not valid.
virtual unsigned int	GetSerializedDescriptionSize (void)=0
	get the size of the whole byte chunk that will be written by Serialize_Out().
virtual unsigned char *	Serialize_Out (unsigned char *_pDescriptionChunkToFill)=0
	write the Current object definition to a Chunk using private packed types, recursively.
virtual unsigned int	WriteFile (const char *_pFileName)
	write a serialized form, using GetSerializedDescriptionSize() and Serialize_Out().
virtual unsigned int	ReadFile (const char *_pFileName)
	Try to read a serialized form, using Serialize_In().
virtual void	SetObjectThatManagesThis (BaseObject *_pManager)
	The Object this one belong to as a member. Should only be used at init.
void	SetMemberName (const char *_MemberName)
	Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() returning NULL should not be edited by an interface or undo-managed. Use REGISTER_MEMBER macros family: it registers the members and use SetMemberName() automatically (or not, according to the compilation mode).
const char *	GetMemberName () const
	Explicits the name of an object when used as a class member. It exists only in editable mode, and then can be used by any GUI. A member with an infoString not NULL, should be drawn in a GUI and receive updates. an object member with GetMemberName() to NULL should not be edited by an interface or undo-managed. set with SetMemberName().
void	SetMemberInfo (const char *_MemberInfo)
	Explicits the use of an object when used as a class member. It should explain what the member does for the object. It exists only in editable mode,and can be used by any GUI. Don't use html tags , only \n are allowed. Use REGISTER_MEMBER_INFO macro after the REGISTER_MEMBER macro in the constructors. It can be left NULL.
const char *	GetMemberInfo () const
	Explicits the use of an object when used as a class member. It exists only in editable mode and can be used by any GUI. It should explain what the member does for the object.
virtual const char *	GetClassID () const =0
	Each BaseType's inherited classes must explicit an ID for their class, or let use one of the super class at least through this virtual method. This is needed by GUIs to detect the types of each sub-members, and shape an interface for each Object according to their member list.
virtual const char *	ValueToString ()
	convert the value of this object to an explicit string. The object manages the string privately, so just read it or copy it. the string would be destroyed with the objects, and changed when using Set() methods.
BaseObject *	GetObjectThatManagesThis ()
	If there is any, get the object that manages this one as a member.
void	MakeCloneOf (BaseType &_ModelObject)
	Tool that makes an object take the values of another using serialization. Use with care: You got to clone a PackUlong with a PackULong, a PackString with a PackString: Clone Object of the same type or it will crash . A test is done at the beginning to check that for both types are the sames, if not it does nothing. however it may still crash with 2 objects from unherited classes. Also, some type like PackObjectReference, will not clone its value by copying a pointer.Reference member clonage is done with BaseObject::Clone().
Protected Member Functions
void	BeginChangeNotification ()
	In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.
void	EndChangeNotification ()
	In edition mode, when a member of an object is changed (like in a Set()), you got to use BeginChangeNotification(), make your changes, and then EndChangeNotification(), so that the edition of this object and member is known by the context, and allows it to manage a GUI update and the undo stack.
Protected Attributes
BaseObject *	m_pObjectThatManagesThis
	an object can belong (or not) to a BaseObject,( and to a BaseContext through it).
const char *	m_pMemberName
	If used as a member in an object, the member name, or NULL (not editable member).
const char *	m_pMemberInfo
	a short string explaining what's the object for in editable mode. OK if NULL (no info).
PackString *	m_pValueString
	a string standing for an expression of the value of the object:
unsigned char *	m_pPreviousValueShape
	used as a temp for object change notification in Begin/EndChangeNotification():
unsigned int	m_PreviousValueShapeLength
Classes
class	ObjectManager
	Nested Class that manages events (TODO,When final, this will give more independances between Base types and Context class). More...