CIP C++ documentation for class "pfcExternalDataClass"

Class pfcExternalDataClass

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

Description

A class that represents a named "bin" for external data so other applications will not use the data by mistake. An application usually needs one class.

Method Summary


`pfcExternalDataSlot_ptr`	`CreateSlot (xrstring Name)`
	Creates a new slot for the external data class

`void`	`Delete ()`
	Deletes the external data class from the model

`xstring`	`GetName ()`
	Unique name of the class for this model

`pfcExternalDataAccess_ptr`	`GetParent ()`
	ExternalDataAccess object to which the class belongs

`xbool`	`IsValid ()`
	Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed.

`pfcExternalDataSlots_ptr`	`ListSlots ()`
	Lists all the slots available for the class

Method Detail

xstring GetName ()

Unique name of the class for this model

Exceptions thrown (but not limited to):

pfcXBadExternalData - Class is no longer valid

pfcExternalDataAccess_ptr GetParent ()

ExternalDataAccess object to which the class belongs

Exceptions thrown (but not limited to):

pfcXBadExternalData - Class is no longer valid

xbool IsValid ()

Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed.

Returns:: The class status

void Delete ()

Deletes the external data class from the model

Deletes permanenly the class and all its slots.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The specified model or class name is invalid.

pfcXBadExternalData - Class is no longer valid

Returns:

pfcExternalDataSlot_ptr CreateSlot (xrstring Name)

Creates a new slot for the external data class

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The specified model or class name is invalid.

pfcXExternalDataClassOrSlotExists - The specified slot already exists in the specified class.

pfcXExternalDataNamesTooLong - The specified slot or class name exceeds the length PRO_NAME_SIZE.

pfcXBadExternalData - Class is no longer valid

Manual References:: External Data: Storing External Data, External Data: Storing External Data

Parameters:

Name: The unique name for the slot. This name cannot begin with a number.

Returns:: The new external data slot

pfcExternalDataSlots_ptr ListSlots ()

Lists all the slots available for the class

Note that slots created by Creo Parametric TOOLKIT applications may not have cutomized names, just numbers.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The model is invalid.

pfcXExternalDataBadDataArgs - The slot ids and/or slot names are invalid.

pfcXBadExternalData - Class is no longer valid

Manual References:: External Data: Retrieving External Data, External Data: Retrieving External Data

Returns:: Sequence of external data slots