XPRMParameter Class
A module or model parameter.
Inheritance Hierarchy
Namespace: Mosel
Assembly: xprmdn (in xprmdn.dll) Version: 4.8.3.0
Syntax
C#
public abstract class XPRMParameter : XPRMTypedIdentifier
The XPRMParameter type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 |
Description |
Get parameter description. Module parameters may provide a textual description of their functionality. Has value null if none available.
|
|
IsReadable |
Check whether the parameter is readable with getparam. This method applies only to module parameters (model parameters are all readable).
|
|
IsWriteable |
Check whether the parameter is writeable with setparam. This property applies only to module parameters (model parameters are all writeable).
|
|
Model |
Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors.
(Inherited from XPRMObjectBase.) |
|
Name |
Property to get this identifier's name
(Inherited from XPRMTypedIdentifier.) |
|
Owner |
Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase.) |
|
StructCode | (Overrides XPRMTypedObjectStructCode.) |
|
StructName | (Inherited from XPRMTypedObject.) |
|
Type | (Inherited from XPRMTypedObject.) |
|
TypeCode | (Inherited from XPRMTypedObject.) |
|
TypeName | (Inherited from XPRMTypedObject.) |
|
Value |
Current value. Value of parameters are available only after the model has been executed.
|
Methods
| Name | Description | |
|---|---|---|
 |
Equals | (Inherited from Object.) |
 |
Finalize |
Allows an
Object to attempt to free resources and perform other cleanup operations before the
Object is reclaimed by garbage collection.
(Inherited from Object.) |
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
GetType |
Gets the
Type of the current instance.
(Inherited from Object.) |
|
GetValue |
Get current value for the given model. Module parameters may have a different value for each model.
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object.
(Inherited from Object.) |
|
ToString |
Returns a default string representation of the identifier
(Inherited from XPRMTypedObject.) |
See Also