CIP C++ documentation for class "wfcAssemblySizeRule"

Class wfcAssemblySizeRule

# include <wfcAssembly.h> class wfcAssemblySizeRule : public virtual wfcAssemblyRule { xdeclare(wfcAssemblySizeRule) ... }; This is a COMPACT class.

Description

The rule for gathering components by their size.

Manual References:: Assemblies and Components: Gathering Components by Size

Method Summary


`static wfcAssemblySizeRule_ptr`	`Create (xbool Absolute, xbool GreaterThan, xbool IncludeDatums, xreal Value)`
	Create an object of AssemblySizeRule.

`xbool`	`GetAbsolute ()`
`void`	`SetAbsolute (xbool value)`
	To compare absolute size of the model and `false` to compare relative size (0.0 - 1.0) with respect to the assembly

`xbool`	`GetGreaterThan ()`
`void`	`SetGreaterThan (xbool value)`
	Set to `true` to collect models that are larger than the specified size, and `false` to collect the smaller ones.

`xbool`	`GetIncludeDatums ()`
`void`	`SetIncludeDatums (xbool value)`
	If `true` use bounding box, if `false` use regeneration outline.

`xreal`	`GetValue ()`
`void`	`SetValue (xreal value)`
	Size to compare against.

Methods Inherited from Class wfcAssemblyRule:: GetRuleType

Method Detail

`xbool`	`GetAbsolute`	`()`
`void`	`SetAbsolute`	`(xbool value)`

To compare absolute size of the model and false to compare relative size (0.0 - 1.0) with respect to the assembly

Manual References:: Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size

`xbool`	`GetGreaterThan`	`()`
`void`	`SetGreaterThan`	`(xbool value)`

Set to true to collect models that are larger than the specified size, and false to collect the smaller ones.

Manual References:: Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size

`xbool`	`GetIncludeDatums`	`()`
`void`	`SetIncludeDatums`	`(xbool value)`

If true use bounding box, if false use regeneration outline.

Manual References:: Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size

`xreal`	`GetValue`	`()`
`void`	`SetValue`	`(xreal value)`

Size to compare against.

Valid range is 0.0 to 1.0 if 'Absolute' attribute is set to false.

Manual References:: Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size

static wfcAssemblySizeRule_ptr Create (xbool Absolute, xbool GreaterThan, xbool IncludeDatums, xreal Value)

Create an object of AssemblySizeRule.

Manual References:: Assemblies and Components: Gathering Components by Size, Assemblies and Components: Gathering Components by Size

Parameters:

Absolute: Specify Absolute (true) or Relative (false) size.
GreaterThan: Specify greater (true) or lesser (false) than size.
IncludeDatums: Specify bounding box (true) or regeneration outline (false).
Value: Size to compare against.

Returns:: The AssemblySizeRule object.