ModuleManager
Public Attributes
bool
Whether the module manager echos extra information to the console or not.
bool
Whether the module manager enforces any dependencies on module definitions it discovers or not.
Public Functions
void
addListener(string listenerObject)
Registers the specified object as a listener for module notifications.
bool
canMergeModules(string mergeSourcePath)
Checks whether a module merge using the modules in the source path can current happen or not.
String
copyModule(string sourceModuleDefinition, string pTargetModuleId, string pTargetPath, bool useVersionPathing)
Copy the module to a new location with a new module Id.
String
findModule(string pModuleId, uint pVersionId)
Find the specific module Id optionally at the specified version Id.
String
findModuleByFilePath(string filePath)
Find the specific module Id optionally at the specified version Id.
String
findModules(bool loadedOnly)
Find all the modules registered with the specified loaded state.
String
findModuleTypes(string pModuleType, bool loadedOnly)
Find the modules registered with the specified module type.
void
ignoreLoadedGroups(bool doIgnore)
Sets if the Module Manager should ingore laoded groups.
bool
Checks whether a module merge definition file is available or not.
bool
loadExplicit(string pModuleId, int pVersionId)
Load the specified module explicitly.
bool
loadGroup(string pModuleGroup)
Load the specified module group.
bool
mergeModules(string pMergeTargetPath, bool removeMergeDefinition, bool registerNewModules)
Performs a module merge into the selected target path.
bool
registerModule(string pModulePath, string pModuleFile)
Register the specified module.
void
removeListener(string listenerObject)
Unregisters the specified object as a listener for module notifications.
bool
renameModule(string sourceModuleDefinition, string pNewModuleName)
Rename a module.
bool
scanModules(string pRootPath, bool rootOnly)
Scans for modules which are sub-directories of the specified path.
bool
setModuleExtension(string moduleExtension)
Set the module extension used to scan for modules. The default is 'module'.
bool
synchronizeDependencies(string rootModuleDefinition, string pTargetDependencyFolder)
Synchronize the module dependencies of a module definition to a target dependency folder.
bool
unloadExplicit(string pModuleId)
Unload the specified module explicitly.
bool
unloadGroup(string pModuleGroup)
Unload the specified module group.
bool
unregisterModule(string pModuleId, bool versionId)
Unregister the specified module.
Detailed Description
UNDOCUMENTED!
Public Attributes
bool EchoInfo
Whether the module manager echos extra information to the console or not.
bool EnforceDependencies
Whether the module manager enforces any dependencies on module definitions it discovers or not.
Public Functions
addListener(string listenerObject)
Registers the specified object as a listener for module notifications.
Parameters:
| listenerObject | The object to start receiving module notifications. |
No return value.
canMergeModules(string 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. |
Whether a module merge using the modules in the source path can current happen or not.
copyModule(string sourceModuleDefinition, string pTargetModuleId, string pTargetPath, bool 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. |
The new module definition file if copy was successful or NULL if not.
findModule(string pModuleId, uint pVersionId)
Find the specific module Id optionally at the specified version Id.
Parameters:
| moduleId | The module Id to find. |
| versionId | The version Id to find. |
The module definition object or NULL if not found.
findModuleByFilePath(string filePath)
Find the specific module Id optionally at the specified version Id.
Parameters:
| moduleId | The module Id to find. |
| versionId | The version Id to find. |
The module definition object or NULL if not found.
findModules(bool loadedOnly)
Find all the modules registered with the specified loaded state.
Parameters:
| loadedOnly | Whether to return only modules that are loaded or not. |
A list of space - separated module definition object Ids.
findModuleTypes(string pModuleType, bool 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. |
A list of space - separated module definition object Ids.
ignoreLoadedGroups(bool doIgnore)
Sets if the Module Manager should ingore laoded groups.
Parameters:
| doIgnore | Whether we should or should not ignore loaded groups. |
No return value.
isModuleMergeAvailable()
Checks whether a module merge definition file is available or not.
Whether a module merge definition file is available or not.
loadExplicit(string pModuleId, int pVersionId)
Load the specified module explicitly.
Parameters:
| moduleId | The module Id to load. |
| versionId | The version Id to load.Optional: Will load the latest version. |
Whether the module Id was loaded or not.
loadGroup(string pModuleGroup)
Load the specified module group.
Parameters:
| moduleGroup | The module group to load. |
Whether the module group was loaded or not.
mergeModules(string pMergeTargetPath, bool removeMergeDefinition, bool 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. |
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.
registerModule(string pModulePath, string pModuleFile)
Register the specified module.
Parameters:
| moduleId | The module Id to register. |
| versionId | The version Id to register. |
Whether the module was registered or not.
removeListener(string listenerObject)
Unregisters the specified object as a listener for module notifications.
Parameters:
| listenerObject | The object to stop receiving module notifications. |
No return value.
renameModule(string sourceModuleDefinition, string pNewModuleName)
Rename a module.
Parameters:
| sourceModuleDefinition | The module definition to rename. |
| pNewModuleName | The new name the module should have. |
Weither the rename was successful or not.
scanModules(string pRootPath, bool rootOnly)
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. |
Whether the scan was successful or not.A successful scan can still find zero modules.
setModuleExtension(string 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. |
Whether setting the module extension was successful or not.
synchronizeDependencies(string rootModuleDefinition, string pTargetDependencyFolder)
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. |
Whether the module dependencies were synchronized correctly or not.
unloadExplicit(string pModuleId)
Unload the specified module explicitly.
Parameters:
| moduleId | The module Id to unload. |
Whether the module Id was unloaded or not.
unloadGroup(string pModuleGroup)
Unload the specified module group.
Parameters:
| moduleGroup | The module group to unload. |
Whether the module group was unloaded or not.
unregisterModule(string pModuleId, bool versionId)
Unregister the specified module.
Parameters:
| moduleId | The module Id to unregister. |
| versionId | The version Id to unregister. |
Whether the module was unregister or not.