CIP C++ documentation for class "pfcDetailLeaders"

Class pfcDetailLeaders

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

Description

This interface represents a set of leaders used by a detail item.

See Also:: pfcDetailNoteInstructions, pfcDetailSymbolInstInstructions, pfcFreeAttachment::Create(pfcPoint3D_ptr), pfcParametricAttachment::Create(pfcSelection_ptr)

Method Summary


`static pfcDetailLeaders_ptr`	`Create ()`
	Creates a data object describing a set of detail item leaders.

`optional xreal`	`GetElbowLength ()`
`void`	`SetElbowLength (optional xreal value)`
	The elbow length for the leaders. If `null`, the default elbow lenghth is used if there are leaders present.

`optional pfcAttachment_ptr`	`GetItemAttachment ()`
`void`	`SetItemAttachment (optional pfcAttachment_ptr value)`
	The location where the detail item is attached. If this is `null` when retrieving the information from an existing symbol, the item's leader type is not supported by this product.

`optional pfcAttachments_ptr`	`GetLeaders ()`
`void`	`SetLeaders (optional pfcAttachments_ptr value)`
	Sequence of leaders. Indicates the locations where the leaders should be attached.If `null`, the detail item will not have leaders.

Method Detail

`optional pfcAttachment_ptr`	`GetItemAttachment`	`()`
`void`	`SetItemAttachment`	`(optional pfcAttachment_ptr value)`

The location where the detail item is attached. If this is null when retrieving the information from an existing symbol, the item's leader type is not supported by this product.

`optional pfcAttachments_ptr`	`GetLeaders`	`()`
`void`	`SetLeaders`	`(optional pfcAttachments_ptr value)`

Sequence of leaders. Indicates the locations where the leaders should be attached.If null, the detail item will not have leaders.

`optional xreal`	`GetElbowLength`	`()`
`void`	`SetElbowLength`	`(optional xreal value)`

The elbow length for the leaders. If null, the default elbow lenghth is used if there are leaders present.

static pfcDetailLeaders_ptr Create ()

Creates a data object describing a set of detail item leaders.

Returns:: The created data object.