CIP JavaScript documentation for class " pfcParameterOwner"

Class pfcParameterOwner

Description

This is a base class for an object that has parameters associated with it (such as model or model item).

See Also:: pfcModel, pfcModelItem

Direct Parent Classes:: pfcActionSource, pfcParent

Direct Known Subclasses:: pfcModelItem, pfcModel, pfcMaterial

Method Summary


`pfcParameter`	`CreateParam (string Name, pfcParamValue Value)`
	Adds the specified parameter to the database and returns it.

`pfcParameter`	`CreateParamWithUnits (string Name, pfcParamValue Value, pfcUnit Units)`
	Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.

`/* optional */ pfcParameter`	`GetParam (string Name)`
	Retrieves the parameter specified by name.

`/* optional */ pfcParameters`	`ListParams ()`
	Provides a list of parameters associated with the parameter owner.

`/* optional */ pfcParameter`	`SelectParam ()`
	Enables a user to select parameters interactively from a list.

`pfcParameters`	`SelectParameters ( /* optional */ pfcParameterSelectionOptions Options)`
	Enables a user to select parameters interactively from a list displayed based on the parameter selection options specified.

Method Detail

pfcParameter CreateParam (string Name, pfcParamValue Value)

Adds the specified parameter to the database and returns it.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is nonexistent.

pfcXToolkitFound - The specified parameter already exists.

Parameters:

Name: The owner (a model item or solid)
Value: The initial data the parameter will hold

Returns:: The newly created parameter

pfcParameter CreateParamWithUnits (string Name, pfcParamValue Value, pfcUnit Units)

Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is nonexistent.

pfcXToolkitFound - The specified parameter already exists.

pfcXToolkitNotValid - The specified parameter is invalid.

Parameters:

Name: Name of the parameter.
Value: The initial data the parameter will hold.Note, the value should be of type double.
Units: The units assigned to this parameter.

Returns:: The newly created parameter.

/* optional */ pfcParameter GetParam (string Name)

Retrieves the parameter specified by name.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is nonexistent.

pfcXToolkitNotFound - The parameter was not found within the owner.

Parameters:

Name: The name of the parameter to query.

Returns:: The retrived parameter, or null if the parameter owner does not have a parameter with the name specified.

/* optional */ pfcParameters ListParams ()

Provides a list of parameters associated with the parameter owner.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No parameters were found.

Returns:: The list of parameters, or null, if no parameters have been found

/* optional */ pfcParameter SelectParam ()

Enables a user to select parameters interactively from a list.

The top model from which the parameters will be selected must be displayed in the current window.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is invalid or not found.

pfcXToolkitNotFound - The owner does not contain parameteers.

pfcXToolkitUserAbort - The user aborted the selection.

pfcXToolkitInvalidType - Invalid context for top_model argument.

Returns:: The list of selected parameters, or null if no parameters were selected.

pfcParameters SelectParameters ( /* optional */ pfcParameterSelectionOptions Options)

Enables a user to select parameters interactively from a list displayed based on the parameter selection options specified.

The top model from which the parameters will be selected must be displayed in the current window.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is invalid or not found.

pfcXToolkitNotFound - The owner does not contain parameteers.

pfcXToolkitUserAbort - The user aborted the selection.

pfcXToolkitInvalidType - Invalid context for top_model argument.

Parameters:

Options: The parameter selection options.

Returns:: The list of selected parameters.