CIP C++ documentation for class "pfcSymbolDefAttachment"

Class pfcSymbolDefAttachment

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

Description

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

Method Summary


`static pfcSymbolDefAttachment_ptr`	`Create (pfcSymbolDefAttachmentType inType, pfcPoint3D_ptr inAttachmentPoint)`
	Creates a data object that represents the way that an instance may be attached to a symbol definition.

`optional xreal`	`GetAttachmentParam ()`
`void`	`SetAttachmentParam (optional xreal value)`
	The parameter on the entity (typically a t parameter). `null`, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.

`pfcPoint3D_ptr`	`GetAttachmentPoint ()`
`void`	`SetAttachmentPoint (pfcPoint3D_ptr value)`
	The attachment point, in the coordinate system of the symbol definition.

`optional xint`	`GetEntityId ()`
`void`	`SetEntityId (optional xint value)`
	The identifier of the symbol definition entity. `null`, if the attachment type is SYMDEFATTACH_FREE.

`pfcSymbolDefAttachmentType`	`GetType ()`
`void`	`SetType (pfcSymbolDefAttachmentType value)`
	The type of attachment.

Method Detail

`pfcSymbolDefAttachmentType`	`GetType`	`()`
`void`	`SetType`	`(pfcSymbolDefAttachmentType value)`

The type of attachment.

`optional xint`	`GetEntityId`	`()`
`void`	`SetEntityId`	`(optional xint value)`

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

`optional xreal`	`GetAttachmentParam`	`()`
`void`	`SetAttachmentParam`	`(optional xreal value)`

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

`pfcPoint3D_ptr`	`GetAttachmentPoint`	`()`
`void`	`SetAttachmentPoint`	`(pfcPoint3D_ptr value)`

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

static pfcSymbolDefAttachment_ptr Create (pfcSymbolDefAttachmentType inType, pfcPoint3D_ptr inAttachmentPoint)

Creates a data object that represents the way that an instance may be attached to a symbol definition.

Parameters:

inType: The type of attachment.
inAttachmentPoint: The attachment point, in the coordinate system of the symbol definition.