Library | PackageFrames | Expand Java Toolkit

Interface ExternalObject

package com.ptc.wfc.wfcExternalObject;

public interface ExternalObject
  extends jxobject


Description

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


Method Summary
voidAddData (ExternalObjectData Data)
     Adds data to an external object
ExternalObjectClassGetClass ()
     
ExternalObjectDataGetData (ExternalObjectDataType 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.
ModelItemGetOwner ()
    Retrieves the owner of an existing external object.
voidModifyData (ExternalObjectData Data)
     Modifies data of an external object
voidRemoveData (ExternalObjectDataType Type)
     Removes data from an external object

Method Detail

AddData

voidAddData (ExternalObjectData 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:

RemoveData

voidRemoveData (ExternalObjectDataType 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:

ModifyData

voidModifyData (ExternalObjectData 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:

GetData

ExternalObjectDataGetData (ExternalObjectDataType 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

GetOwner

ModelItemGetOwner ()


    Retrieves the owner of an existing external object.

Exceptions thrown (but not limited to):

XToolkitNotFound - The owner was not found.


Manual References:
External Objects: External Object Owners
Returns:
The pfcModelItem::ModelItem owner object

GetClass

ExternalObjectClassGetClass ()


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