CIP C++ documentation for class "wfcWFamilyTableRow"

Class wfcWFamilyTableRow

# include <wfcFamily.h> class wfcWFamilyTableRow : public virtual pfcFamilyTableRow { xaideclare(wfcWFamilyTableRow) ... };

Description

Interface wfcWFamilyTableRow adds more functionality to pfcFamilyTableRow.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`wfcWModel_ptr`	`GetModelFromDisk ()`
	Retrieves an instance of a model from disk.

`wfcWModel_ptr`	`GetModelFromSession ()`
	Retrieves the handle to the instance model, if it is in session.

`xbool`	`IsFlatState ()`
	Checks if the family table instance is a sheetmetal flat state instance or not.

`xbool`	`IsModifiable (xbool ShowUI)`
	Check if a given instance is modifiable.

Methods Inherited from Class pfcFamilyTableRow:: GetInstanceName, GetIsLocked, SetIsLocked, GetIsVerified, GetIsExtLocked, CreateInstance, Erase

Method Detail

xbool IsFlatState ()

Checks if the family table instance is a sheetmetal flat state instance or not.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The instance is not of flat state type, but normal family table instance

Manual References:: Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances

xbool IsModifiable (xbool ShowUI)

Check if a given instance is modifiable.

Manual References:: Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances

Parameters:

ShowUI: Indicates whether the Conflicts dialog should be shown to user to resolve conflicts (if they are detected); when set to false no UI is enabled and the instance is considered as modifiable if there are no conflicts that could not be overridden or resolved by default resolution actions.

wfcWModel_ptr GetModelFromSession ()

Retrieves the handle to the instance model, if it is in session.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance model is not in session.

Manual References:: Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances

wfcWModel_ptr GetModelFromDisk ()

Retrieves an instance of a model from disk.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance model was not found on disk.

Manual References:: Family Tables: Operations on Family Table Instances, Family Tables: Operations on Family Table Instances