CIP C++ documentation for class "pfcFamilyTableRow"

Class pfcFamilyTableRow

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

Description

This class specifies a row in a family table.

Manual References:: Family Tables: Accessing Instances, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`pfcModel_ptr`	`CreateInstance ()`
	Regenerates and adds the instance model to memory.

`void`	`Erase ()`
	Erases the specified instance model from memory.

`xstring`	`GetInstanceName ()`
	The name of the instance.

`xbool`	`GetIsExtLocked ()`
	If this is `true`, the instance is locked by external application.

`xbool`	`GetIsLocked ()`
`void`	`SetIsLocked (xbool value)`
	If this is `true`, the model is locked for modification. If this is `false`, the model is unlocked.

`pfcFaminstanceVerifyStatus`	`GetIsVerified ()`
	Specifies the verification status of the instance.

Method Detail

xstring GetInstanceName ()

The name of the instance.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

`xbool`	`GetIsLocked`	`()`
`void`	`SetIsLocked`	`(xbool value)`

If this is true, the model is locked for modification. If this is false, the model is unlocked.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance does not exist in the family table.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances, Family Tables: Accessing Instances

pfcFaminstanceVerifyStatus GetIsVerified ()

Specifies the verification status of the instance.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance does not exist in the family table.

xbool GetIsExtLocked ()

If this is true, the instance is locked by external application.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance does not exist in the family table.

pfcModel_ptr CreateInstance ()

Regenerates and adds the instance model to memory.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.

pfcXToolkitCantOpen - Creo Parametric cannot regenerate the instance. The instance has been created but the failed features have been suppressed.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances, Models: Getting a Model Object

void Erase ()

Erases the specified instance model from memory.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified instance model is not in session.