Sage Modeling and Simulation Library

MaterialTransferSpecByMass Members

The MaterialTransferSpecByMass type exposes the following members.

Constructors


  Name Description
Public method MaterialTransferSpecByMass
Creates a MaterialTransferSpecByMass that will transfer a specified mass of a specified type of material, over a specified duration. It is presumed that duration and mass do NOT scale, so if you want them to, you will need to add the appropriate scaling adapters.

Methods


  Name Description
Public method Clone
Clone operation allows a MTSBM object to be reused, thereby eliminating the need to re-specify each time the transfer is to take place.
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 GetExtract
Gets the material to be transferred by extracting it from the source material.
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.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Rescale
Commands a rescale of the transfer spec's mass and duration to a scale factor of the originally defined size.
Public method SetDurationScalingAdapter
Provides this transferSpec with a scaling adapter that will scale the transfer duration.

As an example, adding a TimeSpanLinearScalingAdapter with a linearity of 1.0 will cause duration to scale precisely in proportion to the aggregate scale provided in the Rescale operation.

Public method SetMassScalingAdapter
Provides this transferSpec with a scaling adapter that will scale the mass to be transferred.

As an example, adding a DoubleLinearScalingAdapter with a linearity of 1.0 will cause mass to scale precisely in proportion to the aggregate scale provided in the Rescale operation.

Public method ToString
Provides a human-readable description of the transfer mass, material, and duration, scaled as requested.

Properties


  Name Description
Public property Duration
The duration of the transfer. This value will reflect any scaling operations that have been done.
Public property DurationScaler
Gets the duration scaler associated with this MaterialTransferSpecByMass.
Public property Mass
The mass to be transferred. This value will reflect any scaling operations that have been done.
Public property MassScaler
Gets the mass scaler associated with this MaterialTransferSpecByMass.
Public property MaterialType
The material type to be transferred.

Events


  Name Description
Public event CloneEvent
Fired after a cloning operation has taken place.