![]() |
Murl Engine API
Version 2018.3
|
The package interface. More...
#include <murl_i_package.h>
The package interface.
Packages operations are processed by a loader thread, the IPackage interface provides methods for controlling and monitoring the package processing.
Inherited by Murl::Core::Package.
Public Member Functions | |
virtual const String & | GetName () const =0 |
Get the name of the package. More... | |
virtual ILoader::LoadMode | GetLoadMode () const =0 |
Get the package's load mode. More... | |
virtual IEnums::FileCategory | GetFileCategory () const =0 |
Get the package's file category. More... | |
virtual const Resource::IPackage * | GetResourcePackage () const =0 |
Get the resource package contained in the package. More... | |
virtual Logic::IProcessorPtr | GetLogicProcessor () const =0 |
Get the logic processor assigned to the package with ILoader::AddPackage(). More... | |
virtual Bool | HasLogicProcessor (Logic::IProcessorPtr logicProcessor) const =0 |
Check if a logic processor is assigned to the package. More... | |
virtual Bool | AddGraphInstance (const String &graphResourceId, const String &parentNodeId, UInt32 numberOfReplications=1)=0 |
Manually add a graph instance to create when the package is loaded. More... | |
virtual Bool | RemoveGraphInstance (const String &graphResourceId, const String &parentNodeId)=0 |
Remove a manually added graph instance. More... | |
virtual Bool | HideGraphInstance (const String &graphResourceId, const String &parentNodeId)=0 |
Manually remove a graph instance from the creation list, i.e. More... | |
virtual Bool | UnhideGraphInstance (const String &graphResourceId, const String &parentNodeId)=0 |
Unhide a graph instance that was previously hidden via HideGraphInstance(). More... | |
virtual Bool | AddScriptInstance (const String &scriptResourceId, UInt32 numberOfReplications=1)=0 |
Manually add a script instance to create when the package is loaded. More... | |
virtual Bool | RemoveScriptInstance (const String &scriptResourceId)=0 |
Remove a manually added script instance. More... | |
virtual Bool | HideScriptInstance (const String &scriptResourceId)=0 |
Manually remove a script instance from the creation list, i.e. More... | |
virtual Bool | UnhideScriptInstance (const String &scriptResourceId)=0 |
Unhide a script instance that was previously hidden via HideScriptInstance(). More... | |
virtual Bool | Query (String *id, UInt32 *revision, Bool *isDataValid, Bool *isVersionValid, Bool *isChecksumValid) const =0 |
Query the package. More... | |
virtual Bool | Load ()=0 |
Start loading the package. More... | |
virtual Bool | Unload ()=0 |
Start unloading the package. More... | |
virtual Bool | EnqueueForLoading ()=0 |
Enqueue the package for loading. More... | |
virtual Bool | EnqueueForUnloading ()=0 |
Enqueue the package for unloading. More... | |
virtual Bool | CancelLoading ()=0 |
Cancel loading the package. More... | |
virtual Bool | CancelUnloading ()=0 |
Cancel unloading the package. More... | |
virtual Bool | IsBusy () const =0 |
Check if the package is busy. More... | |
virtual Bool | IsBusyLoading () const =0 |
Check if the package is busy by loading. More... | |
virtual Bool | IsBusyUnloading () const =0 |
Check if the package is busy by unloading. More... | |
virtual Bool | IsLoaded () const =0 |
Check if the package is loaded. More... | |
virtual Bool | IsUnloaded () const =0 |
Check if the package is unloaded. More... | |
virtual Bool | HasFailedLoading () const =0 |
Check if the package failed to load. More... | |
virtual Bool | HasFailedUnloading () const =0 |
Check if the package failed to unload. More... | |
|
pure virtual |
Get the name of the package.
|
pure virtual |
Get the package's load mode.
|
pure virtual |
Get the package's file category.
|
pure virtual |
Get the resource package contained in the package.
|
pure virtual |
Get the logic processor assigned to the package with ILoader::AddPackage().
|
pure virtual |
Check if a logic processor is assigned to the package.
This method checks the processor assigned with ILoader::AddPackage() and all processors added by script resources.
logicProcessor | The logic processor to check. |
|
pure virtual |
Manually add a graph instance to create when the package is loaded.
This only works for packages using ILoader::LOAD_MODE_ON_DEMAND.
graphResourceId | The resource ID of the graph to create. |
parentNodeId | The ID of the parent node where to insert the graph. |
numberOfReplications | The number of replications of the graph to create. |
|
pure virtual |
Remove a manually added graph instance.
This method is used to remove a graph instance to be created that was previously added via AddGraphInstance(). If it is desired to disable the creation of a graph instance that is statically present in the package, use HideGraphInstance() instead.
graphResourceId | The resource ID of the graph to remove from the creation list. |
parentNodeId | The ID of the parent node where to insert the graph. |
|
pure virtual |
Manually remove a graph instance from the creation list, i.e.
hide the instance. This only works for packages using ILoader::LOAD_MODE_ON_DEMAND.
graphResourceId | The resource ID of the graph to prevent from being created. |
parentNodeId | The ID of the parent node where the graph would be inserted. |
|
pure virtual |
Unhide a graph instance that was previously hidden via HideGraphInstance().
graphResourceId | The resource ID of the graph to unhide. |
parentNodeId | The ID of the parent node where the graph gets inserted. |
|
pure virtual |
Manually add a script instance to create when the package is loaded.
This only works for packages using ILoader::LOAD_MODE_ON_DEMAND.
scriptResourceId | The resource ID of the script to create. |
numberOfReplications | The number of replications of the script to create. |
Remove a manually added script instance.
This method is used to remove a script instance to be created that was previously added via AddScriptInstance(). If it is desired to disable the creation of a script instance that is statically present in the package, use HideScriptInstance() instead.
scriptResourceId | The resource ID of the script to remove from the creation list. |
Manually remove a script instance from the creation list, i.e.
hide the instance. This only works for packages using ILoader::LOAD_MODE_ON_DEMAND.
scriptResourceId | The resource ID of the script to prevent from being created. |
Unhide a script instance that was previously hidden via HideScriptInstance().
scriptResourceId | The resource ID of the script to unhide. |
|
pure virtual |
Query the package.
This method takes a number of pointers to individual variables that receive the results of the query. It is allowed to pass null pointers to any of these variables in case the specific item is not of interest.
id | A pointer to a String object receiving the internal package ID. |
revision | A pointer to a UInt32 variable receiving the package revision. |
isDataValid | A pointer to a Bool variable receiving the general validity of the package data. |
isVersionValid | A pointer to a Bool variable receiving the result of the file format version check. |
isChecksumValid | A pointer to a Bool variable receiving the result of the CRC32 checksum validation. |
|
pure virtual |
Start loading the package.
Calls EnqueueForLoading() if the package is unloaded and not busy loading. Calls CancelUnloading() if the package is busy unloading.
|
pure virtual |
Start unloading the package.
Calls EnqueueForUnloading() if the package is loaded and not busy unloading. Calls CancelLoading() if the package is busy unloading.
|
pure virtual |
Enqueue the package for loading.
|
pure virtual |
Enqueue the package for unloading.
|
pure virtual |
Cancel loading the package.
|
pure virtual |
Cancel unloading the package.
|
pure virtual |
Check if the package is busy.
A package is busy during loading or unloading.
|
pure virtual |
Check if the package is busy by loading.
|
pure virtual |
Check if the package is busy by unloading.
|
pure virtual |
Check if the package is loaded.
|
pure virtual |
Check if the package is unloaded.
|
pure virtual |
Check if the package failed to load.
|
pure virtual |
Check if the package failed to unload.