CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.SymbolDefAttachment"

Interface SymbolDefAttachment

package com.ptc.pfc.pfcDetail; public interface SymbolDefAttachment extends jxobject

Description

This interface represents the way that an instance may be attached to a symbol definition.

Method Summary
`/optional/ Double`	`GetAttachmentParam ()` Get method for attribute "AttachmentParam" The parameter on the entity (typically a t parameter). `null`, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.
`Point3D`	`GetAttachmentPoint ()` Get method for attribute "AttachmentPoint" The attachment point, in the coordinate system of the symbol definition.
`/optional/ Integer`	`GetEntityId ()` Get method for attribute "EntityId" The identifier of the symbol definition entity. `null`, if the attachment type is SYMDEFATTACH_FREE.
`SymbolDefAttachmentType`	`GetType ()` Get method for attribute "Type" The type of attachment.
`void`	`SetAttachmentParam ( /optional/ Double value)` Set method for attribute "AttachmentParam" The parameter on the entity (typically a t parameter). `null`, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.
`void`	`SetAttachmentPoint (Point3D value)` Set method for attribute "AttachmentPoint" The attachment point, in the coordinate system of the symbol definition.
`void`	`SetEntityId ( /optional/ Integer value)` Set method for attribute "EntityId" The identifier of the symbol definition entity. `null`, if the attachment type is SYMDEFATTACH_FREE.
`void`	`SetType (SymbolDefAttachmentType value)` Set method for attribute "Type" The type of attachment.

Method Detail

GetType/SetType

`SymbolDefAttachmentType`	`GetType`	`()`
`void`	`SetType`	`(SymbolDefAttachmentType value)`

The type of attachment.

GetEntityId/SetEntityId

`/optional/ Integer`	`GetEntityId`	`()`
`void`	`SetEntityId`	`( /optional/ Integer value)`

The identifier of the symbol definition entity. null, if the attachment type is SYMDEFATTACH_FREE.

GetAttachmentParam/SetAttachmentParam

`/optional/ Double`	`GetAttachmentParam`	`()`
`void`	`SetAttachmentParam`	`( /optional/ Double value)`

The parameter on the entity (typically a t parameter). null, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.

GetAttachmentPoint/SetAttachmentPoint

`Point3D`	`GetAttachmentPoint`	`()`
`void`	`SetAttachmentPoint`	`(Point3D value)`

The attachment point, in the coordinate system of the symbol definition.