CIP C++ documentation for class "pfcExternalDataSlot"

Class pfcExternalDataSlot

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

Description

Represents a single data item stored in external data

Method Summary


`void`	`Delete ()`
	Deletes the external data slot

`pfcExternalDataClass_ptr`	`GetClass ()`
	Class to which slot belongs

`xint`	`GetId ()`
	Unique identifier assigned by Creo Parametric

`optional xstring`	`GetName ()`
	Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.

`pfcExternalData_ptr`	`GetValue ()`
`void`	`SetValue (pfcExternalData_ptr value)`
	The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an `pfcXBadExternalData`exception will result.

`xbool`	`IsValid ()`
	Returns true if the slot exists and can be accessed, false if it has been deleted.

Method Detail

optional xstring GetName ()

Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

xint GetId ()

Unique identifier assigned by Creo Parametric

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

pfcExternalDataClass_ptr GetClass ()

Class to which slot belongs

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

xbool IsValid ()

Returns true if the slot exists and can be accessed, false if it has been deleted.

Returns:: The status of the slot

void Delete ()

Deletes the external data slot

Permanently deletes the slot and the data it contains.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The model or class name is invalid.

pfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

pfcXExternalDataSlotNotFound - The slot was not found.

pfcXBadExternalData - Slot is no longer valid

Returns:

`pfcExternalData_ptr`	`GetValue`	`()`
`void`	`SetValue`	`(pfcExternalData_ptr value)`

The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an pfcXBadExternalDataexception will result.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The model or class name is invalid.

pfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

pfcXExternalDataSlotNotFound - The slot was not found.

pfcXExternalDataStreamTooLarge - The stream data size is greater than 524288 bytes.

pfcXExternalDataBadDataArgs - The data type or data size is invalid.

pfcXExternalDataEmptySlot - No data exists in the slot.

pfcXBadExternalData - Slot is no longer valid

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