CIP C++ documentation for class "pfcDetailGroupInstructions"

Class pfcDetailGroupInstructions

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

Description

This interface contains information used to describe a detail group item. It may be used when creating detail groups (pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)), or accessing existing groups (pfcDetailGroupItem::Modify(pfcDetailGroupInstructions_ptr) and pfcDetailGroupItem::GetInstructions()).

Method Summary


`static pfcDetailGroupInstructions_ptr`	`Create (xrstring inName, pfcDetailItems_ptr inElements)`
	Creates an instructions data object used to describe the construction of a detail group, for use in the methods `pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)` and `pfcDetailGroupItem::Modify(pfcDetailGroupInstructions_ptr)`.

`pfcDetailItems_ptr`	`GetElements ()`
`void`	`SetElements (pfcDetailItems_ptr value)`
	Sequence of detail items contained in the group.

`optional xbool`	`GetIsDisplayed ()`
`void`	`SetIsDisplayed (optional xbool value)`
	`true` if the group is displayed in the drawing, otherwise `false`.

`xstring`	`GetName ()`
`void`	`SetName (xrstring value)`
	The name of the detail group.

Methods Inherited from Class pfcDetailCreateInstructions:: GetType, GetId

Method Detail

`xstring`	`GetName`	`()`
`void`	`SetName`	`(xrstring value)`

The name of the detail group.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`pfcDetailItems_ptr`	`GetElements`	`()`
`void`	`SetElements`	`(pfcDetailItems_ptr value)`

Sequence of detail items contained in the group.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid type of one of item.

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - The group does not contain any items.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xbool`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`(optional xbool value)`

true if the group is displayed in the drawing, otherwise false.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

static pfcDetailGroupInstructions_ptr Create (xrstring inName, pfcDetailItems_ptr inElements)

Creates an instructions data object used to describe the construction of a detail group, for use in the methods pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr) and pfcDetailGroupItem::Modify(pfcDetailGroupInstructions_ptr).

Manual References:: Drawings: Creating, Modifying and Reading Detail Items, Drawings: Creating, Modifying and Reading Detail Items, Drawings: Instructions, Drawings: Instructions

Parameters:

inName: The name of the group to create.
inElements: Sequence of detail items (these must be entities, groups or notes).

Returns:: The instructions data object.