ModuleManager Class Reference

Inherits SimObject, and SimObject.

Inherited by ModuleDatabase, and ModuleDatabase.

Methods
void	addListener (listenerObject)
void	addListener (listenerObject)
bool	canMergeModules (mergeSourcePath)
bool	canMergeModules (mergeSourcePath)
string	copyModule (sourceModuleDefinition, targetModuleId, targetPath, useVersionPathing?)
string	copyModule (sourceModuleDefinition, targetModuleId, targetPath, useVersionPathing?)
string	findModule (moduleId, versionId)
string	findModule (moduleId, versionId)
string	findModules (loadedOnly?)
string	findModules (loadedOnly?)
string	findModuleTypes (moduleType, loadedOnly?)
string	findModuleTypes (moduleType, loadedOnly?)
bool	isModuleMergeAvailable ()
bool	isModuleMergeAvailable ()
bool	loadExplicit (moduleId,[versionId])
bool	loadExplicit (moduleId,[versionId])
bool	loadGroup (moduleGroup)
bool	loadGroup (moduleGroup)
bool	mergeModules (mergeTargetPath, removeMergeDefinition, registerNewModules)
bool	mergeModules (mergeTargetPath, removeMergeDefinition, registerNewModules)
void	removeListener (listenerObject)
void	removeListener (listenerObject)
bool	scanModules (moduleRootPath,[rootOnly=false])
bool	scanModules (moduleRootPath,[rootOnly=false])
bool	setModuleExtension (moduleExtension)
bool	setModuleExtension (moduleExtension)
bool	synchronizeDependencies (rootModuleDefinition, targetDependencyPath)
bool	synchronizeDependencies (rootModuleDefinition, targetDependencyPath)
bool	unloadExplicit (moduleId)
bool	unloadExplicit (moduleId)
bool	unloadGroup (moduleGroup)
bool	unloadGroup (moduleGroup)
bool	unregisterModule (moduleId, versionId)
bool	unregisterModule (moduleId, versionId)
Methods inherited from SimObject
void	addFieldFilter (fieldName)
void	addFieldFilter (fieldName)
string	call (%args)
string	call (%args)
int	clone ([bool copyDynamicFields?=false])
int	clone ([bool copyDynamicFields?=false])
void	delete ()
void	delete ()
void	dump ()
void	dump ()
void	dumpClassHierarchy ()
void	dumpClassHierarchy ()
string	getClassName ()
string	getClassName ()
string	getClassNamespace ()
string	getClassNamespace ()
string	getDynamicField (index)
string	getDynamicField (index)
int	getDynamicFieldCount ()
int	getDynamicFieldCount ()
string	getField (int index)
string	getField (int index)
int	getFieldCount ()
int	getFieldCount ()
string	getFieldType (fieldName)
string	getFieldType (fieldName)
string	getFieldValue (fieldName)
string	getFieldValue (fieldName)
int	getGroup ()
int	getGroup ()
int	getId ()
int	getId ()
string	getInternalName ()
string	getInternalName ()
string	getName ()
string	getName ()
string	getProgenitorFile ()
string	getProgenitorFile ()
string	getSuperClassNamespace ()
string	getSuperClassNamespace ()
int	getType ()
int	getType ()
bool	isChildOfGroup ()
bool	isChildOfGroup ()
bool	isMemberOfClass (string classname)
bool	isMemberOfClass (string classname)
bool	isMethod (string method name)
bool	isMethod (string method name)
bool	isTimerActive ()
bool	isTimerActive ()
void	removeFieldFilter (fieldName)
void	removeFieldFilter (fieldName)
bool	save (fileName,[selectedOnly])
bool	save (fileName,[selectedOnly])
int	schedule (time, command,< arg1...argN >)
int	schedule (time, command,< arg1...argN >)
void	setClassNamespace ()
void	setClassNamespace ()
bool	setFieldValue (fieldName, value)
bool	setFieldValue (fieldName, value)
void	setInternalName ()
void	setInternalName ()
void	setName (newName)
void	setName (newName)
void	setProgenitorFile (file)
void	setProgenitorFile (file)
void	setSuperClassNamespace ()
void	setSuperClassNamespace ()
bool	startTimer (callbackFunction, float timePeriod,[repeat])
bool	startTimer (callbackFunction, float timePeriod,[repeat])
void	stopTimer ()
void	stopTimer ()

Fields
bool	EchoInfo
bool	EnforceDependencies
SimBase
bool	canSaveDynamicFields
string	internalName
SimObjectPtr	parentGroup
Namespace Linking
string	superclass
string	class
Fields inherited from SimObject
bool	canSaveDynamicFields
string	internalName
SimObjectPtr	parentGroup
string	superclass
string	class

Methods

void ModuleManager::addListener

(

listenerObject

)

• Registers the specified object as a listener for module notifications.

  Parameters

  listenerObject

  The object to start receiving module notifications.

  Returns

  No return value.

void ModuleManager::addListener

(

listenerObject

)

• Registers the specified object as a listener for module notifications.

  Parameters

  listenerObject

  The object to start receiving module notifications.

  Returns

  No return value.

bool ModuleManager::canMergeModules

(

mergeSourcePath

)

• Checks whether a module merge using the modules in the source path can current happen or not.

  Parameters

  mergeSourcePath

  The path where modules to be merged are located.

  Returns

  Whether a module merge using the modules in the source path can current happen or not.

bool ModuleManager::canMergeModules

(

mergeSourcePath

)

• Checks whether a module merge using the modules in the source path can current happen or not.

  Parameters

  mergeSourcePath

  The path where modules to be merged are located.

  Returns

  Whether a module merge using the modules in the source path can current happen or not.

string ModuleManager::copyModule	(	sourceModuleDefinition	,
		targetModuleId	,
		targetPath	,
		useVersionPathing?
	)

• Copy the module to a new location with a new module Id.

  Parameters

  sourceModuleDefinition	The module definition to copy.
  targetModuleId	The module Id to rename the copied module to including all references to the source module Id. It is valid to specifiy the source module Id to produce an identical copy.
  targetPath	The target path to copy the module to. Addition folders will be created depending on whether 'useVersionPathing' is used or not.
  useVersionPathing	Whether to add a '/targetModuleId/versionId' folder to the target path or not. This allows copying multiple versions of the same module Id.

  Returns

  The new module definition file if copy was successful or NULL if not.

string ModuleManager::copyModule	(	sourceModuleDefinition	,
		targetModuleId	,
		targetPath	,
		useVersionPathing?
	)

• Copy the module to a new location with a new module Id.

  Parameters

  sourceModuleDefinition	The module definition to copy.
  targetModuleId	The module Id to rename the copied module to including all references to the source module Id. It is valid to specifiy the source module Id to produce an identical copy.
  targetPath	The target path to copy the module to. Addition folders will be created depending on whether 'useVersionPathing' is used or not.
  useVersionPathing	Whether to add a '/targetModuleId/versionId' folder to the target path or not. This allows copying multiple versions of the same module Id.

  Returns

  The new module definition file if copy was successful or NULL if not.

string ModuleManager::findModule	(	moduleId	,
		versionId
	)

• Find the specific module Id optionally at the specified version Id.

  Parameters

  moduleId	The module Id to find.
  versionId	The version Id to find.

  Returns

  The module definition object or NULL if not found.

string ModuleManager::findModule	(	moduleId	,
		versionId
	)

• Find the specific module Id optionally at the specified version Id.

  Parameters

  moduleId	The module Id to find.
  versionId	The version Id to find.

  Returns

  The module definition object or NULL if not found.

string ModuleManager::findModules

(

loadedOnly?

)

• Find all the modules registered with the specified loaded state.

  Parameters

  loadedOnly

  Whether to return only modules that are loaded or not.

  Returns

  A list of space-separated module definition object Ids.

string ModuleManager::findModules

(

loadedOnly?

)

• Find all the modules registered with the specified loaded state.

  Parameters

  loadedOnly

  Whether to return only modules that are loaded or not.

  Returns

  A list of space-separated module definition object Ids.

string ModuleManager::findModuleTypes	(	moduleType	,
		loadedOnly?
	)

• Find the modules registered with the specified module type.

  Parameters

  moduleType	The module type to search for.
  loadedOnly	Whether to return only modules that are loaded or not.

  Returns

  A list of space-separated module definition object Ids.

string ModuleManager::findModuleTypes	(	moduleType	,
		loadedOnly?
	)

• Find the modules registered with the specified module type.

  Parameters

  moduleType	The module type to search for.
  loadedOnly	Whether to return only modules that are loaded or not.

  Returns

  A list of space-separated module definition object Ids.

bool ModuleManager::isModuleMergeAvailable

(

)

• Checks whether a module merge definition file is available or not.

  Returns

  Whether a module merge definition file is available or not.

bool ModuleManager::isModuleMergeAvailable

(

)

• Checks whether a module merge definition file is available or not.

  Returns

  Whether a module merge definition file is available or not.

bool ModuleManager::loadExplicit

(

moduleId

)

• Load the specified module explicitly.

  Parameters

  moduleId	The module Id to load.
  versionId	The version Id to load. Optional: Will load the latest version.

  Returns

  Whether the module Id was loaded or not.

bool ModuleManager::loadExplicit

(

moduleId

)

• Load the specified module explicitly.

  Parameters

  moduleId	The module Id to load.
  versionId	The version Id to load. Optional: Will load the latest version.

  Returns

  Whether the module Id was loaded or not.

bool ModuleManager::loadGroup

(

moduleGroup

)

• Load the specified module group.

  Parameters

  moduleGroup

  The module group to load.

  Returns

  Whether the module group was loaded or not.

bool ModuleManager::loadGroup

(

moduleGroup

)

• Load the specified module group.

  Parameters

  moduleGroup

  The module group to load.

  Returns

  Whether the module group was loaded or not.

bool ModuleManager::mergeModules	(	mergeTargetPath	,
		removeMergeDefinition	,
		registerNewModules
	)

• Performs a module merge into the selected target path.

  Parameters

  mergeTargetPath	The path where modules will be merged into.
  removeMergeDefinition	Whether to remove any merge definition found or not if merge is successful.
  registerNewModules	Whether new (not replaced or updated) modules should be registered or not.

  Returns

  Whether the module merge was successful or not. Failure here could result in a corrupt module state. Reinstall is recommended or at least advised to the user is recommended.

bool ModuleManager::mergeModules	(	mergeTargetPath	,
		removeMergeDefinition	,
		registerNewModules
	)

• Performs a module merge into the selected target path.

  Parameters

  mergeTargetPath	The path where modules will be merged into.
  removeMergeDefinition	Whether to remove any merge definition found or not if merge is successful.
  registerNewModules	Whether new (not replaced or updated) modules should be registered or not.

  Returns

  Whether the module merge was successful or not. Failure here could result in a corrupt module state. Reinstall is recommended or at least advised to the user is recommended.

void ModuleManager::removeListener

(

listenerObject

)

• Unregisters the specified object as a listener for module notifications.

  Parameters

  listenerObject

  The object to stop receiving module notifications.

  Returns

  No return value.

void ModuleManager::removeListener

(

listenerObject

)

• Unregisters the specified object as a listener for module notifications.

  Parameters

  listenerObject

  The object to stop receiving module notifications.

  Returns

  No return value.

bool ModuleManager::scanModules

(

moduleRootPath

)

• Scans for modules which are sub-directories of the specified path.

  Parameters

  moduleRootPath	The root directory to scan for sub-directories containing modules.
  rootOnly	[Optional] - Specifies whether to only scan the root path or not when searching for modules.

  Returns

  Whether the scan was successful or not. A successful scan can still find zero modules.

bool ModuleManager::scanModules

(

moduleRootPath

)

• Scans for modules which are sub-directories of the specified path.

  Parameters

  moduleRootPath	The root directory to scan for sub-directories containing modules.
  rootOnly	[Optional] - Specifies whether to only scan the root path or not when searching for modules.

  Returns

  Whether the scan was successful or not. A successful scan can still find zero modules.

bool ModuleManager::setModuleExtension

(

moduleExtension

)

• Set the module extension used to scan for modules. The default is 'module'.

  Parameters

  moduleExtension

  The module extension used to scan for modules. Do not use a period character.

  Returns

  Whether setting the module extension was successful or not.

bool ModuleManager::setModuleExtension

(

moduleExtension

)

• Set the module extension used to scan for modules. The default is 'module'.

  Parameters

  moduleExtension

  The module extension used to scan for modules. Do not use a period character.

  Returns

  Whether setting the module extension was successful or not.

bool ModuleManager::synchronizeDependencies	(	rootModuleDefinition	,
		targetDependencyPath
	)

• Synchronize the module dependencies of a module definition to a target dependency folder.

  Parameters

  rootModuleDefinition	The module definition used to determine dependencies.
  targetDependencyPath	The target dependency folder to copy dependencies to.

  Returns

  Whether the module dependencies were synchronized correctly or not.

bool ModuleManager::synchronizeDependencies	(	rootModuleDefinition	,
		targetDependencyPath
	)

• Synchronize the module dependencies of a module definition to a target dependency folder.

  Parameters

  rootModuleDefinition	The module definition used to determine dependencies.
  targetDependencyPath	The target dependency folder to copy dependencies to.

  Returns

  Whether the module dependencies were synchronized correctly or not.

bool ModuleManager::unloadExplicit

(

moduleId

)

• Unload the specified module explicitly.

  Parameters

  moduleId

  The module Id to unload.

  Returns

  Whether the module Id was unloaded or not.

bool ModuleManager::unloadExplicit

(

moduleId

)

• Unload the specified module explicitly.

  Parameters

  moduleId

  The module Id to unload.

  Returns

  Whether the module Id was unloaded or not.

bool ModuleManager::unloadGroup

(

moduleGroup

)

• Unload the specified module group.

  Parameters

  moduleGroup

  The module group to unload.

  Returns

  Whether the module group was unloaded or not.

bool ModuleManager::unloadGroup

(

moduleGroup

)

• Unload the specified module group.

  Parameters

  moduleGroup

  The module group to unload.

  Returns

  Whether the module group was unloaded or not.

bool ModuleManager::unregisterModule	(	moduleId	,
		versionId
	)

• Unregister the specified module.

  Parameters

  moduleId	The module Id to unregister.
  versionId	The version Id to unregister.

  Returns

  Whether the module was unregister or not.

bool ModuleManager::unregisterModule	(	moduleId	,
		versionId
	)

• Unregister the specified module.

  Parameters

  moduleId	The module Id to unregister.
  versionId	The version Id to unregister.

  Returns

  Whether the module was unregister or not.

Member Data Documentation

bool ModuleManager::canSaveDynamicFields

string ModuleManager::class

Script SuperClass of object.

bool ModuleManager::EchoInfo

Whether the module manager echos extra information to the console or not.

bool ModuleManager::EnforceDependencies

Whether the module manager enforces any dependencies on module definitions it discovers or not.

string ModuleManager::internalName

SimObjectPtr ModuleManager::parentGroup

Group hierarchy parent of the object.

string ModuleManager::superclass

Script Class of object.