CIP C++ documentation for class "wfcSurfaceCollectionInstruction"

Class wfcSurfaceCollectionInstruction

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

Description

Class for instruction in surface collection

Method Summary


`static wfcSurfaceCollectionInstruction_ptr`	`Create (wfcSurfaceCollectionInstrType type, xbool Include, optional wfcSurfaceCollectionReferences_ptr SrfCollectionReferences, optional wfcSurfaceCollectionRules_ptr Rules)`
	Creates a surface collection instruction object.

`xbool`	`GetInclude ()`
`void`	`SetInclude (xbool value)`
	Surface collection instruction attribute.

`optional wfcSurfaceCollectionRules_ptr`	`GetRules ()`
`void`	`SetRules (optional wfcSurfaceCollectionRules_ptr value)`
	Surface collection instruction rules. Used for Geometry or Shape based surface collection

`optional wfcSurfaceCollectionReferences_ptr`	`GetSrfCollectionReferences ()`
`void`	`SetSrfCollectionReferences (optional wfcSurfaceCollectionReferences_ptr value)`
	The references contained in a surface collection instruction

`wfcSurfaceCollectionInstrType`	`GetType ()`
`void`	`SetType (wfcSurfaceCollectionInstrType value)`
	The surface collection instruction type

Method Detail

`wfcSurfaceCollectionInstrType`	`GetType`	`()`
`void`	`SetType`	`(wfcSurfaceCollectionInstrType value)`

The surface collection instruction type

Manual References:: Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection

`xbool`	`GetInclude`	`()`
`void`	`SetInclude`	`(xbool value)`

Surface collection instruction attribute.

true - include the surfaces generated by this instruction in the set and false - exclude the surfaces from the set

Manual References:: Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection

`optional wfcSurfaceCollectionReferences_ptr`	`GetSrfCollectionReferences`	`()`
`void`	`SetSrfCollectionReferences`	`(optional wfcSurfaceCollectionReferences_ptr value)`

The references contained in a surface collection instruction

Manual References:: Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection

`optional wfcSurfaceCollectionRules_ptr`	`GetRules`	`()`
`void`	`SetRules`	`(optional wfcSurfaceCollectionRules_ptr value)`

Surface collection instruction rules. Used for Geometry or Shape based surface collection

Manual References:: Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection

static wfcSurfaceCollectionInstruction_ptr Create (wfcSurfaceCollectionInstrType type, xbool Include, optional wfcSurfaceCollectionReferences_ptr SrfCollectionReferences, optional wfcSurfaceCollectionRules_ptr Rules)

Creates a surface collection instruction object.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::pfcXInAMethod>

Manual References:: Curve and Surface Collection: Surface Collection, Curve and Surface Collection: Surface Collection

Parameters:

type
Include
SrfCollectionReferences
Rules

Returns:: A surface collection instruction object.