FlipComponentBuilder Class

class NXOpen.Formboard.FlipComponentBuilder

Bases: NXOpen.Builder

Builder for flip component operation used in formboard.

Allows user to flip the component by 180 degrees about an axis which is orthogonal to Z axis so that after flipping , the component lies in XY plane.

To create a new instance of this class, use NXOpen.Formboard.FormboardManager.CreateFlipComponentBuilder()

Default values.

Property	Value
AxisTypeEnum	PathLocations

New in version NX7.5.0.

Properties

Property	Description
AxisTypeEnum	Returns or sets the user selected NXOpen.Formboard.FlipComponentBuilderAxisType method
CompSel	Returns the formboard component selected by user for flipping operation
CustomAxis	Returns or sets the custom axis which is created when NXOpen.Formboard.FlipComponentBuilderAxisType is NXOpen.Formboard.FlipComponentBuilderAxisType.Custom
PathAxisSel	Returns the axis selected by user about which selected formboard component will be flipped.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CreateDatumAxis	Creates datums axis at locations where selected formboard component is connected to path.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
FlipComponent	Flips the selected formboard component by rotation angle about selected axis.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
InitializeFromComponent	Initializes or resets ( start or stop ) drag operation based on the component selected for flipping operation.
SetRotationAngle	Set the angle to rotate the component.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StartDrag	Starts the drag operation of selected object.
StopDrag	Stop the drag operation of selected object.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

FlipComponentBuilderAxisType Enumeration

Enum for the selection of axis type for flipping formboard component

Property Detail

AxisTypeEnum

FlipComponentBuilder.AxisTypeEnum

Returns or sets the user selected NXOpen.Formboard.FlipComponentBuilderAxisType method

-------------------------------------

Getter Method

Signature AxisTypeEnum

Returns: Return type:NXOpen.Formboard.FlipComponentBuilderAxisType

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

-------------------------------------

Setter Method

Signature AxisTypeEnum

Parameters:axisTypeEnum (NXOpen.Formboard.FlipComponentBuilderAxisType) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

CompSel

FlipComponentBuilder.CompSel

Returns the formboard component selected by user for flipping operation

-------------------------------------

Getter Method

Signature CompSel

Returns: Return type:NXOpen.SelectNXObject

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

CustomAxis

FlipComponentBuilder.CustomAxis

Returns or sets the custom axis which is created when NXOpen.Formboard.FlipComponentBuilderAxisType is NXOpen.Formboard.FlipComponentBuilderAxisType.Custom

-------------------------------------

Getter Method

Signature CustomAxis

Returns: Return type:NXOpen.Axis

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

-------------------------------------

Setter Method

Signature CustomAxis

Parameters:customAxis (NXOpen.Axis) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

PathAxisSel

FlipComponentBuilder.PathAxisSel

Returns the axis selected by user about which selected formboard component will be flipped.

-------------------------------------

Getter Method

Signature PathAxisSel

Returns: Return type:NXOpen.SelectNXObject

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

Method Detail

CreateDatumAxis

FlipComponentBuilder.CreateDatumAxis

Creates datums axis at locations where selected formboard component is connected to path.

Signature CreateDatumAxis()

Returns: Return type:list of NXOpen.NXObject

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

FlipComponent

FlipComponentBuilder.FlipComponent

Flips the selected formboard component by rotation angle about selected axis.

Signature FlipComponent()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

InitializeFromComponent

FlipComponentBuilder.InitializeFromComponent

Initializes or resets ( start or stop ) drag operation based on the component selected for flipping operation.

Signature InitializeFromComponent()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

SetRotationAngle

FlipComponentBuilder.SetRotationAngle

Set the angle to rotate the component.

Signature SetRotationAngle(angle)

Parameters:angle (float) – Rotation angle

New in version NX7.5.3.

License requirements: routing_harness (“Routing Harness”)

StartDrag

FlipComponentBuilder.StartDrag

Starts the drag operation of selected object.

Does nothing if drag has already been started.

Signature StartDrag()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

StopDrag

FlipComponentBuilder.StopDrag

Stop the drag operation of selected object.

Does nothing if drag has not been started.

Signature StopDrag()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

Validate

FlipComponentBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.