CIP JAVA documentation for class "com.ptc.pfc.pfcComponentFeat.ComponentConstraint"

Interface ComponentConstraint

package com.ptc.pfc.pfcComponentFeat; public interface ComponentConstraint extends jxobject

Description

This interface represents a component constraint.

Method Summary
`/optional/ DatumSide`	`GetAssemblyDatumSide ()` Get method for attribute "AssemblyDatumSide" The datum plane side, if the AssemblyReference is a datum plane.
`/optional/ Selection`	`GetAssemblyReference ()` Get method for attribute "AssemblyReference" 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/ ConstraintAttributes`	`GetAttributes ()` Get method for attribute "Attributes" Constraint related attributed. Use `null` for the default settings.
`/optional/ DatumSide`	`GetComponentDatumSide ()` Get method for attribute "ComponentDatumSide" The datum plane side, if the ComponentReference is a datum plane.
`/optional/ Selection`	`GetComponentReference ()` Get method for attribute "ComponentReference" The geometric reference on the component. Use `null` for constraint types not requiring a component reference.
`/optional/ Double`	`GetOffset ()` Get method for attribute "Offset" 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.
`ComponentConstraintType`	`GetType ()` Get method for attribute "Type" The type of constraint.
`/optional/ String`	`GetUserDefinedData ()` Get method for attribute "UserDefinedData" A user created string stored with the constraint. Typically `null`.
`void`	`SetAssemblyDatumSide ( /optional/ DatumSide value)` Set method for attribute "AssemblyDatumSide" The datum plane side, if the AssemblyReference is a datum plane.
`void`	`SetAssemblyReference ( /optional/ Selection value)` Set method for attribute "AssemblyReference" 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.
`void`	`SetAttributes ( /optional/ ConstraintAttributes value)` Set method for attribute "Attributes" Constraint related attributed. Use `null` for the default settings.
`void`	`SetComponentDatumSide ( /optional/ DatumSide value)` Set method for attribute "ComponentDatumSide" The datum plane side, if the ComponentReference is a datum plane.
`void`	`SetComponentReference ( /optional/ Selection value)` Set method for attribute "ComponentReference" The geometric reference on the component. Use `null` for constraint types not requiring a component reference.
`void`	`SetOffset ( /optional/ Double value)` Set method for attribute "Offset" 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.
`void`	`SetType (ComponentConstraintType value)` Set method for attribute "Type" The type of constraint.
`void`	`SetUserDefinedData ( /optional/ String value)` Set method for attribute "UserDefinedData" A user created string stored with the constraint. Typically `null`.

Method Detail

GetType/SetType

`ComponentConstraintType`	`GetType`	`()`
`void`	`SetType`	`(ComponentConstraintType value)`

The type of constraint.

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

GetAssemblyReference/SetAssemblyReference

`/optional/ Selection`	`GetAssemblyReference`	`()`
`void`	`SetAssemblyReference`	`( /optional/ Selection 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

GetAssemblyDatumSide/SetAssemblyDatumSide

`/optional/ DatumSide`	`GetAssemblyDatumSide`	`()`
`void`	`SetAssemblyDatumSide`	`( /optional/ DatumSide 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

GetComponentReference/SetComponentReference

`/optional/ Selection`	`GetComponentReference`	`()`
`void`	`SetComponentReference`	`( /optional/ Selection 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

GetComponentDatumSide/SetComponentDatumSide

`/optional/ DatumSide`	`GetComponentDatumSide`	`()`
`void`	`SetComponentDatumSide`	`( /optional/ DatumSide 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

GetOffset/SetOffset

`/optional/ Double`	`GetOffset`	`()`
`void`	`SetOffset`	`( /optional/ Double 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

GetAttributes/SetAttributes

`/optional/ ConstraintAttributes`	`GetAttributes`	`()`
`void`	`SetAttributes`	`( /optional/ ConstraintAttributes 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

GetUserDefinedData/SetUserDefinedData

`/optional/ String`	`GetUserDefinedData`	`()`
`void`	`SetUserDefinedData`	`( /optional/ String 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