Sage Modeling and Simulation Library

MaterialResourceItem Members

The MaterialResourceItem type exposes the following members.

Constructors


  Name Description
Public method MaterialResourceItem(IModel, MaterialType, Double, Double, Double)
Initializes a new instance of the MaterialResourceItem class with its name being the material type name, and the guid being arbitrarily generated.
Public method MaterialResourceItem(IModel, Guid, MaterialType, Double, Double, Double)
Initializes a new instance of the MaterialResourceItem class with its name being the material type name.
Public method MaterialResourceItem(IModel, MaterialType, Double, Double, Double, Guid) Obsolete.
Initializes a new instance of the MaterialResourceItem class with its name being the material type name.
Public method MaterialResourceItem(IModel, String, Guid, MaterialType, Double, Double, Double, ICollection)
Initializes a new instance of the MaterialResourceItem class.

Methods


  Name Description
Public method Acquire(IResourceRequest)
Acquires the specified request. Removes it from availability and from the resource pool.
Public method Acquire(IResourceRequest, Boolean)
Acquires a resource according to the specified resource request, either blocking until successful, or returning <null> if the resource is not immediately available.
Public method ContainsGuid
Function to check if a guid is contained in this MRI. See 'g' below for possiblitites
Public method Static member ContentsXOR(MaterialResourceItem)
Performs an XOR on mri's MT and Specs to give a unique key into the contents.
Public method Static member ContentsXOR(Guid, Guid)
Performs an XOR on mri's MT and Specs to give a unique key into the contents.
Public method Static member ContentsXOR(Guid, ICollection)
Performs an XOR on mri's MT and Specs to give a unique key into the contents.
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 GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method InitializeIdentity
Initialize the identity of this model object, once.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Release
Releases the specified request. Returns it to availability and the resource pool.
Public method Reserve(IResourceRequest)
Reserves the specified request. Removes it from availability, but not from the pool. This is typically an intermediate state held during resource negotiation.
Public method Reserve(IResourceRequest, Boolean)
Reserves a resource according to the specified resource request, either blocking until successful, or returning <null> if the resource is not immediately available.
Public method Reset
Resets this instance, returning it to its initial capacity and availability.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method Unreserve
Unreserves the specified request. Returns it to availability.

Properties


  Name Description
Public property AccessRegulator
Gets or sets the access regulator, which is an object that can allow or deny individual ResourceRequests access to specified resources. Note - MaterialResourceItem does not support using an access regulator.
Public property Available
How much of this resource is currently available to service requests.
Public property Capacity
The current capacity of this resource - how much 'Available' can be, at its highest value.
Public property Description
A description of this MaterialResourceItem
Public property Guid
Public property InitialAvailable
The amount of material this MaterialResourceItem began with.
Public property InitialCapacity
The amount of capacity this MaterialResourceItem began with.
Public property InitialTemperature
The initial temperature of the material in this MaterialResourceItem.
Public property IsAtomic
Gets a value indicating whether this instance is atomic. And atomic resource is allocated all-or-none, such as a vehicle.
Public property IsDiscrete
Gets a value indicating whether this instance is discrete. A discrete resource is allocated in integral amounts, such as cartons or drums.
Public property IsPersistent
Gets a value indicating whether this instance is persistent. A persistent resource is returned to the pool after it is used.
Public property Manager
Gets or sets the manager of the resource.
Public property MaterialSpecificationGuids
Gets the collection of material specification guids. See the Material Specifications tech note.
Public property MaterialType
The type of the material this MRI holds.
Public property Model
The model that owns this object, or from which this object gets time, etc. data.
Public property Name
Public property PermissibleOverbook
The amount by which it is permissible to overbook this resource.
Public property Resources
Gets the resources owned by this Resource Manager.
Public property SupportsPrioritizedRequests
Gets a value indicating whether this resource manager supports prioritized requests. Note - MaterialResourceItem does not.
Public property Tag
Gets or sets the tag - an arbitrary object attached to this one.

Events


  Name Description
Public event AcquiredEvent
Occurs when this resource has been acquired.
Public event ReleasedEvent
Occurs when this resource has been released.
Public event RequestEvent
Occurs when this resource has been requested.
Public event ReservedEvent
Occurs when this resource has been reserved.
Public event ResourceAcquired
Fired when a resource is acquired and thereby removed from the pool.
Public event ResourceAdded
Fired when a resource is added to the pool.
Public event ResourceReleased
Fired when a resource is released back into the pool.
Public event ResourceRemoved
Fired when a resource is removed from the pool.
Public event ResourceRequested
Fired when a resource request is received.
Public event ResourceReserved
Fired when a resource is reserved.
Public event ResourceUnreserved
Fired when a resource is unreserved.
Public event UnreservedEvent
Occurs when this resource has been unreserved.