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

Interface DetailSymbolDefInstructions

package com.ptc.pfc.pfcDetail; public interface DetailSymbolDefInstructions extends com.ptc.pfc.pfcDetail.DetailCreateInstructions

Description

This interface contains information used to describe a symbol definition. It may be used when creating symbol definition (DetailItemOwner.CreateDetailItem(DetailCreateInstructions)), or accessing existing entities (DetailSymbolDefItem.Modify(DetailSymbolDefInstructions) and DetailSymbolDefItem.GetInstructions()).

See Also:: pfcDetail.SymbolDefAttachment_Create(SymbolDefAttachmentType, Point3D), pfcDetail.TextReference_Create(DetailNoteItem, int, int)

Method Summary
`/optional/ SymbolDefAttachments`	`GetAttachments ()` Get method for attribute "Attachments" Sequence of possible instance attachment points for the symbol definition.
`String`	`GetFullPath ()` Get method for attribute "FullPath" The full path to the symbol definition file.
`/optional/ Boolean`	`GetHasElbow ()` Get method for attribute "HasElbow" `null` or `true` if the symbol definition includes an elbow, `false` if not.
`/optional/ Double`	`GetHeight ()` Get method for attribute "Height" The height value of the symbol definition.
`/optional/ Boolean`	`GetIsTextAngleFixed ()` Get method for attribute "IsTextAngleFixed" `null` or `true` if the text angle is fixed, `false` if not.
`String`	`GetName ()` Get method for attribute "Name" The name of the symbol defintion.
`/optional/ TextReference`	`GetReference ()` Get method for attribute "Reference" The text reference information, or `null` if unused.
`double`	`GetScaledHeight ()` Get method for attribute "ScaledHeight" The symbol definition height in inches.
`/optional/ SymbolDefHeight`	`GetSymbolHeight ()` Get method for attribute "SymbolHeight" The height type for the symbol definition.
`void`	`SetAttachments ( /optional/ SymbolDefAttachments value)` Set method for attribute "Attachments" Sequence of possible instance attachment points for the symbol definition.
`void`	`SetFullPath (String value)` Set method for attribute "FullPath" The full path to the symbol definition file.
`void`	`SetHasElbow ( /optional/ Boolean value)` Set method for attribute "HasElbow" `null` or `true` if the symbol definition includes an elbow, `false` if not.
`void`	`SetHeight ( /optional/ Double value)` Set method for attribute "Height" The height value of the symbol definition.
`void`	`SetIsTextAngleFixed ( /optional/ Boolean value)` Set method for attribute "IsTextAngleFixed" `null` or `true` if the text angle is fixed, `false` if not.
`void`	`SetReference ( /optional/ TextReference value)` Set method for attribute "Reference" The text reference information, or `null` if unused.
`void`	`SetSymbolHeight ( /optional/ SymbolDefHeight value)` Set method for attribute "SymbolHeight" The height type for the symbol definition.

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailCreateInstructions`
`GetType`, `GetId`

Method Detail

GetSymbolHeight/SetSymbolHeight

`/optional/ SymbolDefHeight`	`GetSymbolHeight`	`()`
`void`	`SetSymbolHeight`	`( /optional/ SymbolDefHeight value)`

The height type for the symbol definition.

Exceptions thrown (but not limited to):

XToolkitInvalidType - Invalid symbol definition height type.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetHasElbow/SetHasElbow

`/optional/ Boolean`	`GetHasElbow`	`()`
`void`	`SetHasElbow`	`( /optional/ Boolean value)`

null or true if the symbol definition includes an elbow, false if not.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetIsTextAngleFixed/SetIsTextAngleFixed

`/optional/ Boolean`	`GetIsTextAngleFixed`	`()`
`void`	`SetIsTextAngleFixed`	`( /optional/ Boolean value)`

null or true if the text angle is fixed, false if not.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetHeight/SetHeight

`/optional/ Double`	`GetHeight`	`()`
`void`	`SetHeight`	`( /optional/ Double value)`

The height value of the symbol definition.

This property does not consistently contain a value capable of being related mathematically to the symbol definition height in inches. Use DetailSymbolDefInstructions.GetScaledHeight() instead.

GetScaledHeight

double GetScaledHeight ()

The symbol definition height in inches.

(Inches are always used for the units in the symbol definition).

Exceptions thrown (but not limited to):

XToolkitNotFound - The symbol definition assigned to this data was not yet initialized so the scaled value cannot be accurately retrieved.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetAttachments/SetAttachments

`/optional/ SymbolDefAttachments`	`GetAttachments`	`()`
`void`	`SetAttachments`	`( /optional/ SymbolDefAttachments value)`

Sequence of possible instance attachment points for the symbol definition.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Number of attachments more than PRODTL_SYM_DEF_MAX_ATTACHES

XToolkitNotFound - No attachments were found.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetFullPath/SetFullPath

`String`	`GetFullPath`	`()`
`void`	`SetFullPath`	`(String value)`

The full path to the symbol definition file.

Exceptions thrown (but not limited to):

XToolkitNotFound - Symbol not found in session.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions

GetName

String GetName ()

The name of the symbol defintion.

Exceptions thrown (but not limited to):

XToolkitNotFound - Symbol not found in session.

GetReference/SetReference

`/optional/ TextReference`	`GetReference`	`()`
`void`	`SetReference`	`( /optional/ TextReference value)`

The text reference information, or null if unused.

Manual References:: Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions, Drawings: Detail Symbol Definitions