Sage Modeling and Simulation Library

MaterialType Members

The MaterialType type exposes the following members.

Constructors


  Name Description
Public method MaterialType()()()()
Default constructor for use in serialization. After deserialization, the model must be set by the entity reconstituting the material - it is not serialized explicitly with the material type, since that would prevent the material type from being deserialized into another model.
Public method MaterialType(IModel, String, Guid, Double, Double, MaterialState)
Constructor for MaterialType. Uses default values for all unspecified (see larger ctor) properties, marks Molecular Weight as unknown.
Public method MaterialType(IModel, String, Guid, Double, Double, MaterialState, Double)
Constructor for MaterialType. Uses default values for all unspecified (see larger constructor) properties.
Public method MaterialType(IModel, String, Guid, Double, Double, MaterialState, Double, Double)
Constructor for MaterialType. Provides a way for the user to specify all of the detailed characteristics of the material.

Methods


  Name Description
Public method AddAlias
Adds an alias to this SPB. An alias points to an entry in another SPB. The other SPB need not be a child of this SPB.
(Inherited from SmartPropertyBag.)
Public method AddBoolean
Adds a boolean value to the SPB under a specified key.
(Inherited from SmartPropertyBag.)
Public method AddChildSPB
Adds a child SPB to this SPB. A child SPB is one that is owned by this bag, and whose entries can be treated as sub-entries of this bag. For example, a if a bag, representing a pallet, were to contain another SPB under the key of "Crates", and that SPB contained one SPB for each crate (one of which was keyed as "123-45", and that SPB had a string keyed as "SKU" and another keyed as "Batch", then the following code would retrieve the SKU directly:
C#
string theSKU = (string)myPallet["Crates.123-45.SKU"];
(Inherited from SmartPropertyBag.)
Public method AddDelegate
Adds a delegate to the SPB under a specified key. When this entry is retrieved from the SPB, it will first be located by key, and then be evaluated by calling it, and the value returned from the delegate invocation will be returned to the entity calling into the SPB. Example:
C#
SPBDoubleDelegate spbdd = new SPBDoubleDelegate(this.GetAValue);
mySPB.AddDelegate("someValue",spbdd); // Add the delegate to the SPB.
double theValue = mySPB["someValue"]; // calls into 'this.GetAValue()' and returns the answer.
(Inherited from SmartPropertyBag.)
Public method AddEmissionsClassifications(array<String>[]()[][])
Accepts emissions classifications for this material types. Appropriate string values are SARA, HAP, NATA, VOC, GHG, and ODC.
Public method AddEmissionsClassifications(array<EmissionsClassification>[]()[][])
Tags this material type as having zero or more Emissions Classifications. Any class that derives from EmissionsClassification may be included in this collection.
Public method AddExpression
Adds an expression to this SPB.
(Inherited from SmartPropertyBag.)
Public method AddSnapshottable
Any object can be stored in a SPB if it implements ISupportsMementos. This API performs such storage.
(Inherited from SmartPropertyBag.)
Public method AddString
Adds a string value to the SPB under a specified key.
(Inherited from SmartPropertyBag.)
Public method AddValue
Adds a value (convertible to double) to the SPB under a specified key.
(Inherited from SmartPropertyBag.)
Public method Clear
Removes all objects from the SPB.
(Inherited from SmartPropertyBag.)
Public method ClearEmissionsClassifications
Public method Contains
Determines whether this smart property bag contains the specified key.
(Inherited from SmartPropertyBag.)
Public method CreateMass
Public method DeserializeFrom
Reconstitutes this object from the specified XmlSerializationContext.
Public method Equals(MaterialType)
Ascertains equality between this one and the other one.
Public method Equals(ISupportsMementos)
Returns true if the two SPBs are semantically equal. (In other words, if both have the same entries, and each evaluates as being '.Equal()' to its opposite, then the two bags are equal.)
(Inherited from SmartPropertyBag.)
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method ExistsKey
Returns true if this dictionary (or any dictionary below it) contains a value stored under this key.
(Inherited from SmartPropertyBag.)
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.)
Protected method GetContentsOfKey
Retrieves the contents of a key known to exist in THIS SPB. Throws a SmartPropertyBagContentsException if the key does not exist in this bag.
(Inherited from SmartPropertyBag.)
Public method GetEnumerator
Retrieves an enumerator that cycles through all of the entries in this SPB. If the entry is not a leaf node, then it can have its enumerator invoked, allowing that entry's child list to be walked, and so forth.

C#
private void DumpEnumerable( IEnumerable enumerable, int depth ) {
       foreach ( HierarchicalDictionaryEntry hde in enumerable ) {
           for ( int i = 0 ; i < depth ; i++ ) Trace.Write("\t");
           Trace.Write(hde.Key.ToString() + ", ");
           Trace.Write(hde.Value.GetType() + ", ");
           if ( hde.IsLeaf ) {
               Trace.Write(hde.Value.ToString());
               if ( hde.Value is double ) {
                    _Debug.WriteLine(" <NOTE: this is a double.>");
               } else {
                   _Debug.WriteLine("");
               }
           } else {
               _Debug.WriteLine("");
               DumpEnumerable((IEnumerable)hde.Value,depth+1);
           }
       }
(Inherited from SmartPropertyBag.)
Public method GetEstimatedBoilingPoint
Estimates a boiling point for the substance.
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 GetVaporPressure(Double)
Returns the vapor pressure of this material when at the specified temperature - irrespective of the mixture in which it is contained.
Public method GetVaporPressure(Double, Mixture)
Returns the vapor pressure of this material (in mmHg) when at the specified temperature and in the specified mixture.
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 Remove
Removes an object from this SPB.
(Inherited from SmartPropertyBag.)
Public method SerializeTo
Stores this object to the specified XmlSerializationContext.
Public method SetAntoinesCoefficients3(Double, Double, Double)
Public method SetAntoinesCoefficients3(Double, Double, Double, PressureUnits, TemperatureUnits)
Public method SetAntoinesCoefficientsExt(Double, Double, Double, Double, Double, Double, Double, Double, Double)
Public method SetAntoinesCoefficientsExt(Double, Double)
Public method SetAntoinesCoefficientsExt(Double, Double, Double, Double, Double, Double, Double, Double, Double, PressureUnits, TemperatureUnits)
Public method SetAntoinesCoefficientsExt(Double, Double, PressureUnits, TemperatureUnits)
Public method ToString

Properties


  Name Description
Public property AntoinesLawCoefficients3
Public property AntoinesLawCoefficientsExt
Contains the nine coefficients for the extended form of antoine's law. These are expressed in
Public property Description
A description of this Material Type.
Public property EbullioscopicConstant
Gets or sets the ebullioscopy constant. Ebullioscopic constant (Eb) is the constant that expresses the amount by which the boiling point Tb of a solvent is raised by a solute, through the relation delta_Tb = i x Eb x b where i is the van ' Hoff factor, and b is the molality of the solute.
Public property EmissionsClassifications
Public property Guid
Public property HasChanged
True if this SPB has changed in any way since the last time it was snapshotted.
(Inherited from SmartPropertyBag.)
Public property IsLeaf
Indicates if this SPB is a leaf (whether it contains entries). Fulfills obligation incurred by implementing TreeNode.
(Inherited from SmartPropertyBag.)
Public property IsWritable
Indicates if write operations on this equipment are permitted.
(Inherited from SmartPropertyBag.)
Public property Item
Retrieves an entry from this SPB. Compound keys may be specified if appropriate. For example, if a bag, representing a pallet, were to contain another SPB under the key of "Crates", and that SPB contained one SPB for each crate (one of which was keyed as "123-45", and that SPB had a string keyed as "SKU" and another keyed as "Batch", then the following code would retrieve the SKU directly:
C#
string theSKU = (string)myPallet["Crates.123-45.SKU"];
(Inherited from SmartPropertyBag.)
Public property LatentHeatOfVaporization
Returns the Latent Heat Of Vaporization of the material in Joules per Kilogram.
Public property Memento
Retrieves the memento of this SPB. Includes all state from this bag, other bags' aliased entries, and child bags, as well as the mementos from any entry that implements ISupportsMementos. Optimizations are applied such that a minimum of computation is required to perform the extraction.
(Inherited from SmartPropertyBag.)
Public property Model
The model that owns this object, or from which this object gets time, etc. data.
Public property MolecularWeight
Returns the molecular weight of the material.
Public property Name
Public property ReportsOwnChanges
True if this SPB is capable of reporting its own changes.
(Inherited from SmartPropertyBag.)
Public property SpecificGravity
Returns the specific gravity of the material in kilograms per liter.
Public property SpecificHeat
Returns the specific heat of the material in Joules per Kilogram-degree K.
Public property STPState
Gets or sets the state of the material at Standard Temperature and Pressure.
Public property Tag
Public property VanTHoffFactor
In physical chemistry, the van 't Hoff factor i is the number of moles of solute actually in solution per mole of solid solute added. Roughly, this is the number of ions a molecule of solute breaks into, when dissolved.

Events


  Name Description
Public event MementoChangeEvent
Fired whenever the memento maintained by this SPB has changed.
(Inherited from SmartPropertyBag.)