Library | FileFrames | Expand

Class wfcWParameterOwner

# include <wfcModelItem.h>

class wfcWParameterOwner
 : public virtual pfcParameterOwner
{
    xaideclare(wfcWParameterOwner)
    ...
};

Description

Extends the functionality of pfcParameterOwner
Manual References:
Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes
Direct Known Subclasses:
wfcWModelItem, wfcWModel, wfcWMaterial


Method Summary

voidApplyParameterTableset (wfcParamTableset_ptr ParamTableset)
Assigns this parameter set to the given parameter owner.
voidExportParameterTable (pfcModel_ptr TopMdl, pfcParameterSelectionContexts_ptr Contexts, wfcParamTableExportType ExportType, xrstring Path, wfcParamColumns_ptr Columns, optional pfcParameterOwner_ptr Owner)
Exports a file containing information from the parameter table in Creo Parametric in the CSV or TXT format.

Methods Inherited from Class pfcActionSource:

AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:

GetChild

Methods Inherited from Class pfcParameterOwner:

GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters


Method Detail

voidExportParameterTable (pfcModel_ptr TopMdl, pfcParameterSelectionContexts_ptr Contexts, wfcParamTableExportType ExportType, xrstring Path, wfcParamColumns_ptr Columns, optional pfcParameterOwner_ptr Owner)

Exports a file containing information from the parameter table in Creo Parametric in the CSV or TXT format.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The owner is invalid or not found and/or Design Test Mode is active - the function is not available in this mode

pfcXToolkitNotFound - The owner does not contain parameters.

pfcXToolkitCantWrite - Creo Parametric could not write to the file path specified.

pfcXToolkitInvalidType - Invalid context for top_model argument.


Manual References:
Dimensions and Parameters: Creating and Accessing Parameters
Parameters:
TopMdl
The top level model from which parameters will be exported.
Contexts
A list containing the context of parameters to list in the export. (Members of pfcParameterSelectionContext). Used only if "owner" is NULL. The following options are supported:
  • pfcPARAMSELECT_ALLOW_SUBITEM_SELECTION alone, all parameters of all subitems of top_model will be exported.
  • pfcPARAMSELECT_ALLOW_SUBITEM_SELECTION and other contexts, only the indicated contexts' parameters will be exported.
  • pfcPARAMSELECT_MODEL, pfcPARAMSELECT_PART or pfcPARAMSELECT_ASM: all model level parameters in top model will be exported.
No other combination is permitted.
ExportType
The type of export file to create.
Path
Full path to the file to export (including name and extension).
Columns
A list containing one or more columns to include in the exported file. This applies only when the file is being exported in the CSV format, and not when the file is being exported in the TXT format (where the columns exported will match the columns and options set by the user in the active session, in accordance with the behavior of File->Export in the Parameter dialog box).
Owner
The owner of the parameters to be exported. May be NULL if the parameter should be selected by context.
Returns:


voidApplyParameterTableset (wfcParamTableset_ptr ParamTableset)

Assigns this parameter set to the given parameter owner.

Parameters called by the set will be created or modified, as appropriate. The parameter values will be set to the default values. This function does not perform a regeneration.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The parameter owner already has one or more required parameters defined and they are not driven by this table.


Manual References:
Dimensions and Parameters: Creating and Accessing Parameters, Dimensions and Parameters: Creating and Accessing Parameters
Parameters:
ParamTableset
The parameter table set.
Returns: