API Documentation > Interface Classes > 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:
User Guide References:
Direct Known Subclasses:
Methods Inherited from Class pfcActionSource::
Methods Inherited from Class pfcParent::
Method Summary
Adds the specified parameter to the database and returns it.
Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.
Retrieves the parameter specified by name.
Provides a list of parameters associated with the parameter owner.
Enables a user to select parameters interactively from a list.
Enables a user to select parameters interactively from a list displayed based on the parameter selection options specified.
Method Detail
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.
User Guide References:
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
(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.
User Guide References:
Parameters:
Name
The owner (a model item or solid)
Value
The initial data the parameter will hold
Returns:
The newly created parameter
ListParams
()
Provides a list of parameters associated with the parameter owner.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - No parameters were found.
User Guide References:
Returns:
The list of parameters, or null, if no parameters have been found
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.
User Guide References:
Returns:
The list of selected parameters, or null if no parameters were selected.
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.
User Guide References:
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
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.
User Guide References:
Parameters:
Options
The parameter selection options.
Returns:
The list of selected parameters.
Was this helpful?