ModuleManager Class Reference

#include <moduleManager.h>

Inheritance diagram for ModuleManager:

Public Types
typedef Vector < ModuleDefinition * >	typeModuleDefinitionVector
	Module definitions. More...
typedef Vector< const ModuleDefinition * >	typeConstModuleDefinitionVector
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }

Public Member Functions
	ModuleManager ()
virtual	~ModuleManager ()
virtual bool	onAdd ()
	SimObject overrides. More...
virtual void	onRemove ()
	Called when the object is removed from the sim. More...
virtual void	onDeleteNotify (SimObject *object)
	DECLARE_CONOBJECT (ModuleManager)
	Declare Console Object. More...
bool	setModuleExtension (const char *pExtension)
	Module definitions. More...
bool	scanModules (const char *pPath, const bool rootOnly=false)
	Module discovery. More...
bool	unregisterModule (const char *pModuleId, const U32 versionId)
	Module unregister. More...
bool	loadModuleGroup (const char *pModuleGroup)
	Module (un)loading. More...
bool	unloadModuleGroup (const char *pModuleGroup)
bool	loadModuleExplicit (const char *pModuleId, const U32 versionId=0)
bool	unloadModuleExplicit (const char *pModuleId)
ModuleDefinition *	findModule (const char *pModuleId, const U32 versionId)
	Module type enumeration. More...
ModuleDefinition *	findLoadedModule (const char *pModuleId)
void	findModules (const bool loadedOnly, typeConstModuleDefinitionVector &moduleDefinitions)
void	findModuleTypes (const char *pModuleType, const bool loadedOnly, typeConstModuleDefinitionVector &moduleDefinitions)
StringTableEntry	copyModule (ModuleDefinition *pSourceModuleDefinition, const char *pTargetModuleId, const char *pTargetPath, const bool useVersionPathing)
	Module synchronization. More...
bool	synchronizeDependencies (ModuleDefinition *pRootModuleDefinition, const char *pTargetDependencyPath)
bool	isModuleMergeAvailable (void) const
	Module updates. More...
bool	canMergeModules (const char *pMergeSourcePath)
bool	mergeModules (const char *pMergeTargetPath, const bool removeMergeDefinition, const bool registerNewModules)
void	addListener (SimObject *pListener)
	Module notifications. More...
void	removeListener (SimObject *pListener)
Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const
StringTableEntry	getSuperClassNamespace () const
void	setClassNamespace (const char *classNamespace)
void	setSuperClassNamespace (const char *superClassNamespace)
void	pushScriptCallbackGuard (void)
void	popScriptCallbackGuard (void)
S32	getScriptCallbackGuard (void)
virtual SimObject *	findObject (const char *name)
Namespace *	getNamespace ()
	Return the object's namespace. More...
const char *	tabComplete (const char *prevText, S32 baseLen, bool)
virtual void	dump ()
virtual void	dumpClassHierarchy ()
SimObject *	clone (const bool copyDynamicFields)
virtual void	copyTo (SimObject *object)
template<typename T >
bool	isType (void)
virtual bool	handlesConsoleMethod (const char *fname, S32 *routingId)
	DECLARE_CONOBJECT (SimObject)
Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...
void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...
void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...
void	clearAllNotifications ()
	Remove all notifications for this object. More...
void	processDeleteNotifies ()
	Send out deletion notifications. More...
void	registerReference (SimObject **obj)
void	unregisterReference (SimObject **obj)
const char *	getDataField (StringTableEntry slotName, const char *array)
void	setDataField (StringTableEntry slotName, const char *array, const char *value)
const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)
void	setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value)
const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)
StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)
U32	getDataFieldType (StringTableEntry slotName, const char *array)
SimFieldDictionary *	getFieldDictionary ()
void	clearDynamicFields (void)
	Clear all dynamic fields. More...
void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...
bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...
void	setInternalName (const char *newname)
StringTableEntry	getInternalName ()
	Get the internal of of this control. More...
virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...
virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...
SimObjectId	getId (void) const
StringTableEntry	getIdString (void) const
U32	getType () const
const StringTableEntry	getName (void) const
void	setId (SimObjectId id)
void	assignName (const char *name)
SimGroup *	getGroup () const
bool	isChildOfGroup (SimGroup *pGroup)
bool	isProperlyAdded () const
bool	isDeleted () const
bool	isRemoved () const
bool	isLocked ()
void	setLocked (bool b)
bool	isHidden ()
void	setHidden (bool b)
void	setProgenitorFile (const char *pFile)
StringTableEntry	getProgenitorFile (void) const
void	setPeriodicTimerID (const S32 timerID)
S32	getPeriodicTimerID (void) const
bool	isPeriodicTimerActive (void) const
bool	isSelected () const
bool	isExpanded () const
void	setSelected (bool sel)
void	setExpanded (bool exp)
void	setModDynamicFields (bool dyn)
void	setModStaticFields (bool sta)
	SimObject (const U8 namespaceLinkMask=LinkSuperClassName|LinkClassName)
virtual	~SimObject ()
virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...
virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...
virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...
virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...
virtual void	onStaticModified (const char *slotName, const char *newValue=NULL)
virtual void	inspectPreApply ()
virtual void	inspectPostApply ()
virtual void	onEditorEnable ()
	Called when the editor is activated. More...
virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...
bool	registerObject ()
bool	registerObject (U32 id)
bool	registerObject (const char *name)
bool	registerObject (const char *name, U32 id)
void	unregisterObject ()
void	deleteObject ()
bool	addToSet (SimObjectId)
bool	addToSet (const char *)
bool	removeFromSet (SimObjectId)
bool	removeFromSet (const char *)
virtual bool	writeField (StringTableEntry fieldname, const char *value)
virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)
virtual void	writeFields (Stream &stream, U32 tabStop)
virtual bool	writeObject (Stream *stream)
virtual bool	readObject (Stream *stream)
virtual void	buildFilterList ()
void	addFieldFilter (const char *fieldName)
void	removeFieldFilter (const char *fieldName)
void	clearFieldFilters ()
bool	isFiltered (const char *fieldName)
void	assignFieldsFrom (SimObject *obj)
void	assignDynamicFieldsFrom (SimObject *obj)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...
virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...
bool	setField (const char *fieldName, const char *value)
	Set the value of a field. More...
virtual	~ConsoleObject ()
const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...
AbstractClassRep::FieldList &	getModifiableFieldList ()
bool &	getDynamicGroupExpand ()
S32	getClassId (U32 netClassGroup) const
const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()
Static Public Member Functions inherited from SimObject
static void	initPersistFields ()
Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag. More...
static void	initPersistFields ()
static void	consoleInit ()
static ConsoleObject *	create (const char *in_pClassName)
static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)
static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class. More...
static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass. More...

Additional Inherited Members
Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }
Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks. More...
virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object. More...
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object. More...
virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)
virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent. More...
virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written. More...
virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read. More...
void	linkNamespaces ()
void	unlinkNamespaces ()
Static Protected Member Functions inherited from SimObject
static bool	setClass (void *obj, const char *data)
static bool	setSuperClass (void *obj, const char *data)
static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
static bool	writeInternalName (void *obj, StringTableEntry pFieldName)
static bool	setParentGroup (void *obj, const char *data)
static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)
static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)
static bool	writeClass (void *obj, StringTableEntry pFieldName)
static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...
static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...
Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object. More...
StringTableEntry	mIdString
Namespace *	mNameSpace
U32	mTypeMask
S32	mScriptCallbackGuard
	Whether the object is executing a script callback. More...
bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true More...
StringTableEntry	mInternalName
	Stores object Internal Name. More...
StringTableEntry	mClassName
	Stores the class name to link script class namespaces. More...
StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces. More...
U8	mNSLinkMask
Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Detailed Description

See Also

Module Manager Reference

Member Typedef Documentation

typedef Vector<const ModuleDefinition*> typeConstModuleDefinitionVector

typedef Vector<ModuleDefinition*> typeModuleDefinitionVector

Module definitions.

Constructor & Destructor Documentation

ModuleManager

(

)

virtual ~ModuleManager ( )

inlinevirtual

Member Function Documentation

void addListener

(

SimObject *

pListener

)

Module notifications.

bool canMergeModules

(

const char *

pMergeSourcePath

)

StringTableEntry copyModule	(	ModuleDefinition *	pSourceModuleDefinition,
		const char *	pTargetModuleId,
		const char *	pTargetPath,
		const bool	useVersionPathing
	)

Module synchronization.

DECLARE_CONOBJECT

(

ModuleManager

)

Declare Console Object.

ModuleDefinition * findLoadedModule

(

const char *

pModuleId

)

ModuleDefinition * findModule	(	const char *	pModuleId,
		const U32	versionId
	)

Module type enumeration.

void findModules	(	const bool	loadedOnly,
		typeConstModuleDefinitionVector &	moduleDefinitions
	)

void findModuleTypes	(	const char *	pModuleType,
		const bool	loadedOnly,
		typeConstModuleDefinitionVector &	moduleDefinitions
	)

void initPersistFields ( void  )

static

bool isModuleMergeAvailable ( void  ) const

inline

Module updates.

bool loadModuleExplicit	(	const char *	pModuleId,
		const U32	versionId = 0
	)

bool loadModuleGroup

(

const char *

pModuleGroup

)

Module (un)loading.

bool mergeModules	(	const char *	pMergeTargetPath,
		const bool	removeMergeDefinition,
		const bool	registerNewModules
	)

bool onAdd ( void  )

virtual

SimObject overrides.

Reimplemented from SimObject.

void onDeleteNotify ( SimObject *  object )

virtual

Called when a SimObject is deleted.

When you are on the notification list for another object and it is deleted, this method is called.

Reimplemented from SimObject.

void onRemove ( )

virtual

Called when the object is removed from the sim.

Reimplemented from SimObject.

void removeListener

(

SimObject *

pListener

)

bool scanModules	(	const char *	pPath,
		const bool	rootOnly = false
	)

Module discovery.

bool setModuleExtension

(

const char *

pExtension

)

Module definitions.

bool synchronizeDependencies	(	ModuleDefinition *	pRootModuleDefinition,
		const char *	pTargetDependencyPath
	)

bool unloadModuleExplicit

(

const char *

pModuleId

)

bool unloadModuleGroup

(

const char *

pModuleGroup

)

bool unregisterModule	(	const char *	pModuleId,
		const U32	versionId
	)

Module unregister.

---

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

• module/moduleManager.h
• module/moduleManager.cc