CIP C++ documentation for class "pfcComponentConstraint"

Class pfcComponentConstraint

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

Description

This interface represents a component constraint.

Method Summary


`static pfcComponentConstraint_ptr`	`Create (pfcComponentConstraintType Type)`
	Creates a new component constraint object.

`optional pfcDatumSide`	`GetAssemblyDatumSide ()`
`void`	`SetAssemblyDatumSide (optional pfcDatumSide value)`
	The datum plane side, if the AssemblyReference is a datum plane.

`optional pfcSelection_ptr`	`GetAssemblyReference ()`
`void`	`SetAssemblyReference (optional pfcSelection_ptr value)`
	The geometric reference from the assembly. This reference must be created using an assembly component path. Use `null` for constraint types not requiring a component reference.

`optional pfcConstraintAttributes_ptr`	`GetAttributes ()`
`void`	`SetAttributes (optional pfcConstraintAttributes_ptr value)`
	Constraint related attributed. Use `null` for the default settings.

`optional pfcDatumSide`	`GetComponentDatumSide ()`
`void`	`SetComponentDatumSide (optional pfcDatumSide value)`
	The datum plane side, if the ComponentReference is a datum plane.

`optional pfcSelection_ptr`	`GetComponentReference ()`
`void`	`SetComponentReference (optional pfcSelection_ptr value)`
	The geometric reference on the component. Use `null` for constraint types not requiring a component reference.

`optional xreal`	`GetOffset ()`
`void`	`SetOffset (optional xreal value)`
	The offset value, if appropriate to the constraint type. Use `null` to represent a 0.0 value, or for constraint types not requiring an offset.

`pfcComponentConstraintType`	`GetType ()`
`void`	`SetType (pfcComponentConstraintType value)`
	The type of constraint.

`optional xstring`	`GetUserDefinedData ()`
`void`	`SetUserDefinedData (optional xrstring value)`
	A user created string stored with the constraint. Typically `null`.

Method Detail

`pfcComponentConstraintType`	`GetType`	`()`
`void`	`SetType`	`(pfcComponentConstraintType value)`

The type of constraint.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional pfcSelection_ptr`	`GetAssemblyReference`	`()`
`void`	`SetAssemblyReference`	`(optional pfcSelection_ptr value)`

The geometric reference from the assembly. This reference must be created using an assembly component path. Use null for constraint types not requiring a component reference.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional pfcDatumSide`	`GetAssemblyDatumSide`	`()`
`void`	`SetAssemblyDatumSide`	`(optional pfcDatumSide value)`

The datum plane side, if the AssemblyReference is a datum plane.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional pfcSelection_ptr`	`GetComponentReference`	`()`
`void`	`SetComponentReference`	`(optional pfcSelection_ptr value)`

The geometric reference on the component. Use null for constraint types not requiring a component reference.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional pfcDatumSide`	`GetComponentDatumSide`	`()`
`void`	`SetComponentDatumSide`	`(optional pfcDatumSide value)`

The datum plane side, if the ComponentReference is a datum plane.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional xreal`	`GetOffset`	`()`
`void`	`SetOffset`	`(optional xreal value)`

The offset value, if appropriate to the constraint type. Use null to represent a 0.0 value, or for constraint types not requiring an offset.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional pfcConstraintAttributes_ptr`	`GetAttributes`	`()`
`void`	`SetAttributes`	`(optional pfcConstraintAttributes_ptr value)`

Constraint related attributed. Use null for the default settings.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

`optional xstring`	`GetUserDefinedData`	`()`
`void`	`SetUserDefinedData`	`(optional xrstring value)`

A user created string stored with the constraint. Typically null.

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

static pfcComponentConstraint_ptr Create (pfcComponentConstraintType Type)

Creates a new component constraint object.

See Also:: pfcComponentFeat::SetConstraints(optional pfcComponentConstraints_ptr, optional pfcComponentPath_ptr)

Manual References:: Assemblies and Components: Assembling a Component Parametrically, Assemblies and Components: Assembling a Component Parametrically

Parameters:

Type: The type of constraint.

Returns:: The new component constraint object.