Sage Modeling and Simulation Library

MaterialResourceRequest Members

The MaterialResourceRequest type exposes the following members.

Methods


  Name Description
Public method Acquire
Public method CompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetScore
Gets the score that describes the suitability of the resource to fulfill this resource request.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Release
Public method Reserve
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method Unreserve

Properties


  Name Description
Public property AbortHandler
This method is called if the resource request is pending, and gets aborted, for example due to resource deadlocking. It can be null, in which case no deadlock detection is provided for the implementing type of ResourceRequest.
Public property AsyncGrantConfirmationCallback
This callback is called when a request, made with a do-not-block specification, that was initially refused, is finally deemed grantable, and provides the callee (presumably the original requester) with an opportunity to say, "No, I don't want that any more", or perhaps to get ready for receipt of the resource in question.
Public property AsyncGrantNotificationCallback
Called after a resource request is granted asynchronously.
Public property DefaultResourceManager
This is the resource manager from which a resource is obtained if none is provided in the reserve or acquire API calls.
Public property Key
Public property MaterialSpecs
Gets the material specs.
Public property MaterialType
Gets the type of the material.
Public property Priority
Public property QuantityDesired
Public property QuantityObtained
Public property Replicate
Creates a fresh replica of this resource request, without any of the in-progress data. This replica can be used to generate another, similar resource request that can acquire its own resource.
Public property Requester
Public property RequiredResource
Public property ResourceObtained
Public property ResourceObtainedFrom
Public property ResourceSelectionStrategy
Public property Status
Gets the status of this resource request.
Public property UserData
Data maintained by this resource request on behalf of the requester.

Events


  Name Description
Public event PriorityChangeEvent
Public event ResourceRequestAborting
Typically fires as a result of the RequestAbortHandler being called. In that method, it picks up the IResourceRequest identity, and is passed on through this event, which includes the IResourceRequest.