IMcResourceManager Interface |
![]() |
Namespace: MediaCy.IQL.Engine
Public Interface IMcResourceManager
The IMcResourceManager type exposes the following members.
Name | Description | |
---|---|---|
![]() | CommandData | |
![]() | CommandFlags | |
![]() | EngineLocal | The IMcEngine instance in use by the calling thread |
![]() | EngineSingleton | The singleton IMcEngine instance. |
![]() | ImageUndoLimits | Sets and exposes limits on whether and how image memory is placed on the undo stack.. |
![]() | IsCurrentThreadMain | Returns True if the calling thread is the main (singleton UI) thread |
![]() | MemoryFree | Reports the amount of memory available for a given use (type). |
![]() | MemoryManagerInfo | Exposes information about the current state of the image memory manager. |
![]() | MemoryMax | Reports the maximum amount of memory available for a given use (memory type). |
![]() | MemoryMissing | This property is set to the difference between MemoryFree and the amount of
memory required in a failed call to ReserveMemory. |
![]() | MemorySwapFree | Returns the amount of swap space free on the current swap drive. |
![]() | MemorySwapMax | Returns the total amount of hard disk space on the current swap drive. |
![]() | MemorySwapPath | The path to be used if the memory manager needs to swap out image memory. |
![]() | MemoryUsed | Reports the amount of memory in use for a given use (type). |
![]() | MiscellaneousResources | Sets and exposes persisted miscellaneous resource values as floating point numbers. |
![]() | NumberOfFrames | Reports the number of image frames open. |
![]() | NumberOfImages | Reports the number of images open. |
![]() | ResetSettingsCount | Gets the current count of ResetSettings calls. |
![]() | TasksQueued | Number of tasks waiting to be processed or currently being processed. |
![]() | TheApplication | The singleton IMcApplication instance |
![]() | ThreadsAllowed | The number of threads allowed for the given type. |
![]() | ThreadsFree | The number of threads available for the given type. |
![]() | ThreadsInUse | The number of threads currently in use for the given type. |
![]() | ThreadsMissing | This property is set to the difference between ThreadsAllowed and the number of threads required in a failed call to ReserveThreads. |
![]() | ThreadsOsFactor | A number between 0 and 1 defining if and how to modulate the number of threads based on CPU utilization. |
![]() | ThreadsPerCore | Number of threads allowed for each physical core |
![]() | ThreadsQueueFactor | A number between 0 and 1 defining how much priority to give to the first commands in the task queue as opposed to distributing resources amongst all queued commands. |
![]() | ThreadsTaskFactor | A number between 0 and 1 defining how to distribute resources between background engine main threads and operator sub-threads. |
![]() | ThreadsTotalCount | # cores * ThreadsPerCore * ( 1 � ThreadsOsFactor * 100 / CPU) |
Name | Description | |
---|---|---|
![]() | AdjustTasksQueued | Atomically adjusts the TasksQueued property by the given delta value. |
![]() | DoCommand | |
![]() | EngineCreationOrderFromOperator | Returns the engine creation order of a given Operator (an interface that exposes IMcHasObject). |
![]() | EngineFromCreationOrder | Returns the engine associated with a given creation order. |
![]() | FreeUpMemory | Controls freeing up an amount of memory for a given use (memory type). |
![]() | RefreshMemory | Either inquire about an existing memory reservation or revise an existing
reservation. |
![]() | RefreshThreads | This function releases the threads owned by the threadHandle and reserves numberThreads in one call using the same rules as ReserveThreads. |
![]() | ReleaseMemory | This function releases the memory owned by memoryHandle.
A PropertyChanged( ID_IMcResourceManager_ReleaseMemory, type) event is fired after the
reserved memory block is removed. The event type argument gives the mcMemoryType of the
removed block. Tasks that are waiting for reservable memory can handle this event to know
when reservable memory becomes available. The currently reservable memory for a given
type can be determined by calling ReserveMemory with the PcntOrMBytes argument set to
zero. |
![]() | ReleaseThreads | This function releases threads previously allocated with ReserveThreads. |
![]() | ReserveMemory | This function is used to reserve some memory, no allocation is made. |
![]() | ReserveThreads | This function reserves numberTreads threads of the given type and increment the thread properties accordingly. |
![]() | ResetSettings | Notifies the ResourceManager that settings have been reset (removed). |
![]() | SetMemoryLimit | Controls the memory limits that determine the maximum amount of memory
available for a given use (memory type). |