CIP JAVA documentation for class "com.ptc.pfc.pfcModelItem.ParameterOwner"

Interface ParameterOwner

package com.ptc.pfc.pfcModelItem; public interface ParameterOwner extends com.ptc.pfc.pfcBase.ActionSource, com.ptc.pfc.pfcObject.Parent

Description

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

See Also:: Model, ModelItem

Direct Known Subclasses:: ModelItem, Model, Material, WParameterOwner

Method Summary
`Parameter`	`CreateParam (String Name, ParamValue Value)` Adds the specified parameter to the database and returns it.
`Parameter`	`CreateParamWithUnits (String Name, ParamValue Value, Unit Units)` Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.
`/optional/ Parameter`	`GetParam (String Name)` Retrieves the parameter specified by name.
`/optional/ Parameters`	`ListParams ()` Provides a list of parameters associated with the parameter owner.
`/optional/ Parameter`	`SelectParam ()` Enables a user to select parameters interactively from a list.
`Parameters`	`SelectParameters ( /optional/ ParameterSelectionOptions Options)` Enables a user to select parameters interactively from a list displayed based on the parameter selection options specified.

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Method Detail

GetParam

/*optional*/ Parameter GetParam (String Name)

Retrieves the parameter specified by name.

Exceptions thrown (but not limited to):

XToolkitBadContext - The owner is nonexistent.

XToolkitNotFound - The parameter was not found within the owner.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters

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.

CreateParam

Parameter CreateParam (String Name, ParamValue Value)

Adds the specified parameter to the database and returns it.

Exceptions thrown (but not limited to):

XToolkitBadContext - The owner is nonexistent.

XToolkitFound - The specified parameter already exists.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters, Overview of Creo Object TOOLKIT Java: Creo-Related Interfaces

Parameters:

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

Returns:: The newly created parameter

ListParams

/*optional*/ Parameters ListParams ()

Provides a list of parameters associated with the parameter owner.

Exceptions thrown (but not limited to):

XToolkitNotFound - No parameters were found.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters

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

SelectParam

/*optional*/ Parameter 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):

XToolkitBadContext - The owner is invalid or not found.

XToolkitNotFound - The owner does not contain parameteers.

XToolkitUserAbort - The user aborted the selection.

XToolkitInvalidType - Invalid context for top_model argument.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters

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

CreateParamWithUnits

Parameter CreateParamWithUnits (String Name, ParamValue Value, Unit 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):

XToolkitBadContext - The owner is nonexistent.

XToolkitFound - The specified parameter already exists.

XToolkitNotValid - The specified parameter is invalid.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters

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.

SelectParameters

Parameters SelectParameters ( /*optional*/ ParameterSelectionOptions 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):

XToolkitBadContext - The owner is invalid or not found.

XToolkitNotFound - The owner does not contain parameteers.

XToolkitUserAbort - The user aborted the selection.

XToolkitInvalidType - Invalid context for top_model argument.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Parameter Selection Options

Parameters:

Options: The parameter selection options.

Returns:: The list of selected parameters.