CIP JavaScript documentation for class " pfcParameter"

Class pfcParameter

Description

This class defines a parameter object.

Property Summary


`/* optional */ string`	`Description`
	Parameter description string.

`/* readonly / / optional */ pfcUnit`	`Units`
	Units assigned to the parameter.

Method Summary


`void`	`Delete ()`
	Deletes a parameter.

`/* optional */ pfcParameterDriverType`	`GetDriverType ()`
	Obtains the type of driver for a material parameter.

`/* optional */ pfcParameterRestriction`	`GetRestriction ()`
	Identifies if a parameter's value is restricted to a certain range or enumerated.

`pfcParamValue`	`GetScaledValue ()`
	Gets the parameter value in the units of the parameter, instead of the units of the owner model.

`void`	`Reorder ( /* optional */ pfcParameter ParamBefore)`
	Reorders the given parameter to come just after the indicated parameter.

`void`	`SetScaledValue (pfcParamValue value, /* optional */ pfcUnit Units)`
	Sets the parameter value in terms of the units provided, instead of using the units of the owner model.

Property Detail

/* optional */ string Description

Parameter description string.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The parameter's description is not set.

/* readonly */ /* optional */ pfcUnit Units

Units assigned to the parameter.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The parameter is unitless.

Method Detail

void Delete ()

Deletes a parameter.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

/* optional */ pfcParameterDriverType GetDriverType ()

Obtains the type of driver for a material parameter.

/* optional */ pfcParameterRestriction GetRestriction ()

Identifies if a parameter's value is restricted to a certain range or enumerated.

pfcParamValue GetScaledValue ()

Gets the parameter value in the units of the parameter, instead of the units of the owner model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

void Reorder ( /* optional */ pfcParameter ParamBefore)

Reorders the given parameter to come just after the indicated parameter.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Parameter 'param_before' does not have the same owner as the parameter to be reordered.

pfcXToolkitNoLicense - No license is available for this functionality.

Parameters:

ParamBefore: The parameter to be just before the reordered parameter. If NULL, the reordered parameter is moved to the first position in the parameter list.

void SetScaledValue (pfcParamValue value, /* optional */ pfcUnit Units)

Sets the parameter value in terms of the units provided, instead of using the units of the owner model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

pfcXToolkitInvalidType - The unit type provided does not match the units of the parameter.

Parameters:

value: The value of the parameter to be set.
Units: The units in which the value is expressed. The value can be null.