RealParameter Class

Real-Valued parameter for use in the CAPE-OPEN parameter collection.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
[GuidAttribute("77E39C43-046B-4b1f-9EE0-AA9EFC55D2EE")]
public class RealParameter : CapeParameter, 
	ICapeParameter, ICapeParameterSpec, ICapeRealParameterSpec, ICloneable, IATCapeXRealParameterSpec
Inheritance
Object    CapeIdentification    CapeParameter    RealParameter
Implements
IATCapeXRealParameterSpec, ICapeParameter, ICapeParameterSpec, ICapeRealParameterSpec, ICloneable

Constructors

RealParameter(String, Double, Double, String) Creates a new instance of the double precision-valued parameter class.
RealParameter(String, String, Double, Double, CapeParamMode, String) Creates a new instance of the double precision-valued parameter class.
RealParameter(String, String, Double, Double, Double, Double, CapeParamMode, String) Creates a new instance of the double precision-valued parameter class.

Properties

ComponentDescription Gets and sets the description of the component.
(Inherited from CapeIdentification)
ComponentName Gets and sets the name of the component.
(Inherited from CapeIdentification)
DefaultValue Gets and sets the default value of the parameter.
DimensionedValue Gets and sets the parameter value in the current unit for its dimensionality.
LowerBound Gets and sets the lower bound of the parameter.
Mode Gets and sets the mode of the parameter.
(Inherited from CapeParameter)
SIUnit Gets the Aspen display unit for the parameter.
SIValue Gets and sets the parameter value in the SI unit for its current dimensionality.
Unit Gets and sets the dimensional unit for the parameter.
UpperBound Gets and sets the upper bound of the parameter.
ValStatus Gets the flag to indicate parameter validation's status.
(Inherited from CapeParameter)

Methods

ConvertTo Returns the current value of the parameter in the dimensional unit specified.
ConvertToSI Returns the value in the SI unit of the specified unit.
NotifyPropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
OnComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnComponentNameChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnParameterDefaultValueChanged Occurs when the user changes of the default value of a parameter.
OnParameterLowerBoundChanged Occurs when the user changes of the lower bound of a parameter.
OnParameterModeChanged Occurs when the user changes of the mode of a parameter.
(Inherited from CapeParameter)
OnParameterReset Occurs when the user resets a parameter.
(Inherited from CapeParameter)
OnParameterUpperBoundChanged Occurs when the user changes of the upper bound of a parameter.
OnParameterValidated Occurs when a parameter is validated.
(Inherited from CapeParameter)
OnParameterValueChanged Occurs when the user changes of the value of a paramter.
(Inherited from CapeParameter)
Reset Sets the value of the parameter to its default value.
(Overrides CapeParameterReset)
Validate(String) Validates the current value of the parameter against the specification of the parameter.
(Overrides CapeParameterValidate(String))
Validate(Double, String) Validates the value sent against the specification of the parameter.

Events

ComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
ComponentNameChanged Occurs when the user changes of the name of a component.
(Inherited from CapeIdentification)
ParameterDefaultValueChanged Occurs when the user changes of the default value of the parameter changes.
ParameterLowerBoundChanged Occurs when the user changes of the lower bound of the parameter changes.
ParameterModeChanged Occurs when the user changes of the mode of the parameter changes.
(Inherited from CapeParameter)
ParameterReset Occurs when the user changes of the parameter value is reset to the default value.
(Inherited from CapeParameter)
ParameterUpperBoundChanged Occurs when the user changes of the upper bound of the parameter changes.
ParameterValidated Occurs when the user validates the parameter.
(Inherited from CapeParameter)
ParameterValueChanged Occurs when the user changes of the value of the parameter changes.
(Inherited from CapeParameter)
PropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)

Fields

Extension Methods

GetEnumNames
(Defined by General)
IsValidDouble
(Defined by General)

Explicit Interface Implementations

ICloneableClone Creates a copy of the parameter.

See Also