Click or drag to resize

IMcResourceManager Interface

An interface implemented by McResourceManager.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Public Interface IMcResourceManager

The IMcResourceManager type exposes the following members.

Properties
  NameDescription
Public propertyCommandData
Public propertyCommandFlags
Public propertyEngineLocal
The IMcEngine instance in use by the calling thread
Public propertyEngineSingleton
The singleton IMcEngine instance.
Public propertyImageUndoLimits
Sets and exposes limits on whether and how image memory is placed on the undo stack..
Public propertyIsCurrentThreadMain
Returns True if the calling thread is the main (singleton UI) thread
Public propertyMemoryFree
Reports the amount of memory available for a given use (type).
Public propertyMemoryManagerInfo
Exposes information about the current state of the image memory manager.
Public propertyMemoryMax
Reports the maximum amount of memory available for a given use (memory type).
Public propertyMemoryMissing
This property is set to the difference between MemoryFree and the amount of memory required in a failed call to ReserveMemory.
Public propertyMemorySwapFree
Returns the amount of swap space free on the current swap drive.
Public propertyMemorySwapMax
Returns the total amount of hard disk space on the current swap drive.
Public propertyMemorySwapPath
The path to be used if the memory manager needs to swap out image memory.
Public propertyMemoryUsed
Reports the amount of memory in use for a given use (type).
Public propertyMiscellaneousResources
Sets and exposes persisted miscellaneous resource values as floating point numbers.
Public propertyNumberOfFrames
Reports the number of image frames open.
Public propertyNumberOfImages
Reports the number of images open.
Public propertyResetSettingsCount
Gets the current count of ResetSettings calls.
Public propertyTasksQueued
Number of tasks waiting to be processed or currently being processed.
Public propertyTheApplication
The singleton IMcApplication instance
Public propertyThreadsAllowed
The number of threads allowed for the given type.
Public propertyThreadsFree
The number of threads available for the given type.
Public propertyThreadsInUse
The number of threads currently in use for the given type.
Public propertyThreadsMissing
This property is set to the difference between ThreadsAllowed and the number of threads required in a failed call to ReserveThreads.
Public propertyThreadsOsFactor
A number between 0 and 1 defining if and how to modulate the number of threads based on CPU utilization.
Public propertyThreadsPerCore
Number of threads allowed for each physical core
Public propertyThreadsQueueFactor
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.
Public propertyThreadsTaskFactor
A number between 0 and 1 defining how to distribute resources between background engine main threads and operator sub-threads.
Public propertyThreadsTotalCount
# cores * ThreadsPerCore * ( 1 � ThreadsOsFactor * 100 / CPU)
Top
Methods
  NameDescription
Public methodAdjustTasksQueued
Atomically adjusts the TasksQueued property by the given delta value.
Public methodDoCommand
Public methodEngineCreationOrderFromOperator
Returns the engine creation order of a given Operator (an interface that exposes IMcHasObject).
Public methodEngineFromCreationOrder
Returns the engine associated with a given creation order.
Public methodFreeUpMemory
Controls freeing up an amount of memory for a given use (memory type).
Public methodRefreshMemory
Either inquire about an existing memory reservation or revise an existing reservation.
Public methodRefreshThreads
This function releases the threads owned by the threadHandle and reserves numberThreads in one call using the same rules as ReserveThreads.
Public methodReleaseMemory
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.
Public methodReleaseThreads
This function releases threads previously allocated with ReserveThreads.
Public methodReserveMemory
This function is used to reserve some memory, no allocation is made.
Public methodReserveThreads
This function reserves numberTreads threads of the given type and increment the thread properties accordingly.
Public methodResetSettings
Notifies the ResourceManager that settings have been reset (removed).
Public methodSetMemoryLimit
Controls the memory limits that determine the maximum amount of memory available for a given use (memory type).
Top
See Also