CIP C++ documentation for class "pfcDetailSymbolDefInstructions"

Class pfcDetailSymbolDefInstructions

# include <pfcDetail.h> class pfcDetailSymbolDefInstructions : public virtual pfcDetailCreateInstructions { xdeclare(pfcDetailSymbolDefInstructions) ... }; This is a COMPACT class.

Description

This interface contains information used to describe a symbol definition. It may be used when creating symbol definition (pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)), or accessing existing entities (pfcDetailSymbolDefItem::Modify(pfcDetailSymbolDefInstructions_ptr) and pfcDetailSymbolDefItem::GetInstructions()).

See Also:: pfcSymbolDefAttachment::Create(pfcSymbolDefAttachmentType, pfcPoint3D_ptr), pfcTextReference::Create(pfcDetailNoteItem_ptr, xint, xint)

Method Summary


`static pfcDetailSymbolDefInstructions_ptr`	`Create (xrstring inFullPath)`
	Creates an instructions object used to create a symbol definition. Pass this object to `pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)` and `pfcDetailSymbolDefItem::Modify(pfcDetailSymbolDefInstructions_ptr)`.

`optional pfcSymbolDefAttachments_ptr`	`GetAttachments ()`
`void`	`SetAttachments (optional pfcSymbolDefAttachments_ptr value)`
	Sequence of possible instance attachment points for the symbol definition.

`xstring`	`GetFullPath ()`
`void`	`SetFullPath (xrstring value)`
	The full path to the symbol definition file.

`optional xbool`	`GetHasElbow ()`
`void`	`SetHasElbow (optional xbool value)`
	`null` or `true` if the symbol definition includes an elbow, `false` if not.

`optional xreal`	`GetHeight ()`
`void`	`SetHeight (optional xreal value)`
	The height value of the symbol definition.

`optional xbool`	`GetIsTextAngleFixed ()`
`void`	`SetIsTextAngleFixed (optional xbool value)`
	`null` or `true` if the text angle is fixed, `false` if not.

`xstring`	`GetName ()`
	The name of the symbol defintion.

`optional pfcTextReference_ptr`	`GetReference ()`
`void`	`SetReference (optional pfcTextReference_ptr value)`
	The text reference information, or `null` if unused.

`xreal`	`GetScaledHeight ()`
	The symbol definition height in inches.

`optional pfcSymbolDefHeight`	`GetSymbolHeight ()`
`void`	`SetSymbolHeight (optional pfcSymbolDefHeight value)`
	The height type for the symbol definition.

Methods Inherited from Class pfcDetailCreateInstructions:: GetType, GetId

Method Detail

`optional pfcSymbolDefHeight`	`GetSymbolHeight`	`()`
`void`	`SetSymbolHeight`	`(optional pfcSymbolDefHeight value)`

The height type for the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid symbol definition height type.

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

`optional xbool`	`GetHasElbow`	`()`
`void`	`SetHasElbow`	`(optional xbool 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

`optional xbool`	`GetIsTextAngleFixed`	`()`
`void`	`SetIsTextAngleFixed`	`(optional xbool 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

`optional xreal`	`GetHeight`	`()`
`void`	`SetHeight`	`(optional xreal 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 pfcDetailSymbolDefInstructions::GetScaledHeight() instead.

xreal GetScaledHeight ()

The symbol definition height in inches.

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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

`optional pfcSymbolDefAttachments_ptr`	`GetAttachments`	`()`
`void`	`SetAttachments`	`(optional pfcSymbolDefAttachments_ptr value)`

Sequence of possible instance attachment points for the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Number of attachments more than PRODTL_SYM_DEF_MAX_ATTACHES

pfcXToolkitNotFound - No attachments were found.

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

`xstring`	`GetFullPath`	`()`
`void`	`SetFullPath`	`(xrstring value)`

The full path to the symbol definition file.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Symbol not found in session.

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

xstring GetName ()

The name of the symbol defintion.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Symbol not found in session.

`optional pfcTextReference_ptr`	`GetReference`	`()`
`void`	`SetReference`	`(optional pfcTextReference_ptr value)`

The text reference information, or null if unused.

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

static pfcDetailSymbolDefInstructions_ptr Create (xrstring inFullPath)

Creates an instructions object used to create a symbol definition. Pass this object to pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr) and pfcDetailSymbolDefItem::Modify(pfcDetailSymbolDefInstructions_ptr).

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

Parameters:

inFullPath: Path and name for the symbol definition.

Returns:: The instructions data object.