CIP Visual Basic.NET documentation for interface "IpfcExternalDataClass"

Interface IpfcExternalDataClass

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.

Direct Parent Classes:: IpfcObject

Property Summary


`Property`	`Name`	`as String`
	Unique name of the class for this model

`Property`	`Parent`	`as IpfcExternalDataAccess`
	ExternalDataAccess object to which the class belongs

Method Summary


`Function`	`CreateSlot (Name as String) as IpfcExternalDataSlot`
	Creates a new slot for the external data class

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

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

`Function`	`ListSlots () as IpfcExternalDataSlots`
	Lists all the slots available for the class

Property Detail

Property Name as String

Unique name of the class for this model

Exceptions thrown (but not limited to):

IpfcXBadExternalData - Class is no longer valid

Property Parent as IpfcExternalDataAccess

ExternalDataAccess object to which the class belongs

Exceptions thrown (but not limited to):

IpfcXBadExternalData - Class is no longer valid

Method Detail

Function CreateSlot (Name as String) as IpfcExternalDataSlot

Creates a new slot for the external data class

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The specified model or class name is invalid.

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

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

IpfcXBadExternalData - Class is no longer valid

Parameters:

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

Returns:: The new external data slot

Sub Delete ()

Deletes the external data class from the model

Deletes permanenly the class and all its slots.

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The specified model or class name is invalid.

IpfcXBadExternalData - Class is no longer valid

Function IsValid () as Boolean

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

Function ListSlots () as IpfcExternalDataSlots

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):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The model is invalid.

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

IpfcXBadExternalData - Class is no longer valid

Returns:: Sequence of external data slots