CIP C++ documentation for class "pfcParameterOwner"

Class pfcParameterOwner

# include <pfcModelItem.h> class pfcParameterOwner : public virtual pfcActionSource, : public virtual pfcParent { xaideclare(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

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: pfcModelItem, pfcModel, pfcMaterial, wfcWParameterOwner

Method Summary


`pfcParameter_ptr`	`CreateParam (xrstring Name, pfcParamValue_ptr Value)`
	Adds the specified parameter to the database and returns it.

`pfcParameter_ptr`	`CreateParamWithUnits (xrstring Name, pfcParamValue_ptr Value, pfcUnit_ptr Units)`
	Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.

`optional pfcParameter_ptr`	`GetParam (xrstring Name)`
	Retrieves the parameter specified by name.

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

`optional pfcParameter_ptr`	`SelectParam ()`
	Enables a user to select parameters interactively from a list.

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

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Method Detail

optional pfcParameter_ptr GetParam (xrstring 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.

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.

pfcParameter_ptr CreateParam (xrstring Name, pfcParamValue_ptr 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.

Manual References:: Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters, Overview of Creo Object TOOLKIT C++: 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

optional pfcParameters_ptr ListParams ()

Provides a list of parameters associated with the parameter owner.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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

optional pfcParameter_ptr 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.

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.

pfcParameter_ptr CreateParamWithUnits (xrstring Name, pfcParamValue_ptr Value, pfcUnit_ptr 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.

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.

pfcParameters_ptr SelectParameters (optional pfcParameterSelectionOptions_ptr 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.

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.