CIP Visual Basic.NET documentation for interface "IpfcParameterOwner"

Interface IpfcParameterOwner

Description

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

See Also:: IpfcModel, IpfcModelItem

Direct Parent Classes:: IpfcActionSource, IpfcParent

Direct Known Subclasses:: IpfcModelItem, IpfcModel, IpfcMaterial

Method Summary


`Function`	`CreateParam (Name as String, Value as IpfcParamValue) as IpfcParameter`
	Adds the specified parameter to the database and returns it.

`Function`	`CreateParamWithUnits (Name as String, Value as IpfcParamValue, Units as IpfcUnit) as IpfcParameter`
	Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.

`Function`	`GetParam (Name as String) as IpfcParameter [optional]`
	Retrieves the parameter specified by name.

`Function`	`ListParams () as IpfcParameters [optional]`
	Provides a list of parameters associated with the parameter owner.

`Function`	`SelectParam () as IpfcParameter [optional]`
	Enables a user to select parameters interactively from a list.

`Function`	`SelectParameters (Options as IpfcParameterSelectionOptions [optional]) as IpfcParameters`
	Enables a user to select parameters interactively from a list displayed based on the parameter selection options specified.

Method Detail

Function CreateParam (Name as String, Value as IpfcParamValue) as IpfcParameter

Adds the specified parameter to the database and returns it.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The owner is nonexistent.

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

Function CreateParamWithUnits (Name as String, Value as IpfcParamValue, Units as IpfcUnit) as IpfcParameter

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

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The owner is nonexistent.

IpfcXToolkitFound - The specified parameter already exists.

IpfcXToolkitNotValid - 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.

Function GetParam (Name as String) as IpfcParameter [optional]

Retrieves the parameter specified by name.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The owner is nonexistent.

IpfcXToolkitNotFound - 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.

Function ListParams () as IpfcParameters [optional]

Provides a list of parameters associated with the parameter owner.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - No parameters were found.

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

Function SelectParam () as IpfcParameter [optional]

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):

IpfcXToolkitBadContext - The owner is invalid or not found.

IpfcXToolkitNotFound - The owner does not contain parameteers.

IpfcXToolkitUserAbort - The user aborted the selection.

IpfcXToolkitInvalidType - Invalid context for top_model argument.

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

Function SelectParameters (Options as IpfcParameterSelectionOptions [optional]) as IpfcParameters

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):

IpfcXToolkitBadContext - The owner is invalid or not found.

IpfcXToolkitNotFound - The owner does not contain parameteers.

IpfcXToolkitUserAbort - The user aborted the selection.

IpfcXToolkitInvalidType - Invalid context for top_model argument.

Parameters:

Options: The parameter selection options.

Returns:: The list of selected parameters.