CIP C++ documentation for class "wfcExternalObject"

Class wfcExternalObject

# include <wfcExternalObject.h> class wfcExternalObject : public virtual xobject { xaideclare(wfcExternalObject) ... };

Description

This interface provides access to external objects Interface has methods to add,delete and modify data required for external objects

Method Summary


`void`	`AddData (wfcExternalObjectData_ptr Data)`
	Adds data to an external object

`wfcExternalObjectClass_ptr`	`GetClass ()`


`wfcExternalObjectData_ptr`	`GetData (wfcExternalObjectDataType Type)`
	Gets external object's data. NOTE: Currently, GetData cannot retrieve a sequence of colors set using ExternalObjectDisplayData::SetEntityColors. These color values are returned as pfcCOLOR_CURVE. This functionality is reserved for future use.

`pfcModelItem_ptr`	`GetOwner ()`
	Retrieves the owner of an existing external object.

`void`	`ModifyData (wfcExternalObjectData_ptr Data)`
	Modifies data of an external object

`void`	`RemoveData (wfcExternalObjectDataType Type)`
	Removes data from an external object

Method Detail

void AddData (wfcExternalObjectData_ptr Data)

Adds data to an external object

Manual References:: External Objects: Manipulating External Object Data, External Objects: Manipulating External Object Data

Parameters:

Data: External object data to add

Returns:

void RemoveData (wfcExternalObjectDataType Type)

Removes data from an external object

Manual References:: External Objects: Manipulating External Object Data, External Objects: Manipulating External Object Data

Parameters:

Type: Type of the data to remove e.g. display data or selection data

Returns:

void ModifyData (wfcExternalObjectData_ptr Data)

Modifies data of an external object

Manual References:: External Objects: Manipulating External Object Data, External Objects: Manipulating External Object Data

Parameters:

Data: Modified external object data

Returns:

wfcExternalObjectData_ptr GetData (wfcExternalObjectDataType Type)

Gets external object's data.

NOTE: Currently, GetData cannot retrieve a sequence of colors set using ExternalObjectDisplayData::SetEntityColors.

These color values are returned as pfcCOLOR_CURVE. This functionality is reserved for future use.

Manual References:: External Objects: Manipulating External Object Data, External Objects: Manipulating External Object Data

Parameters:

Type: Type of the data to remove e.g. display data or selection data

Returns:: Data of an external object

pfcModelItem_ptr GetOwner ()

Retrieves the owner of an existing external object.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The owner was not found.

Manual References:: External Objects: External Object Owners

Returns:: The pfcModelItem::ModelItem owner object

wfcExternalObjectClass_ptr GetClass ()

Manual References:: External Objects: Manipulating External Object Data

Returns: