Contains information about flattened harness drawing and drafting data for harness manufacturing drawings (Formboard Drawings). More...

Inheritance diagram for NXOpen.Formboard.FormboardManager:

Public Types
enum	LegacyComponentOrientationConfidenceLevel { High, Medium, Low }
	Returned from FormboardManager.CalculateLegacyComponentClocking as a measure of the confidence in the calculated clocking. More...

enum	LegacyComponentOrientationDisplayStyle { NoDisplay, DisplayCurveNormals, DisplaySurface, DisplayAll }
	Used by FormboardManager.CalculateLegacyComponentClocking to display extra information you can use to see how the clocking calculation is made. More...

Public Member Functions
unsafe void	AddPartAs3dHarness (NXOpen.Part harnessPart)
	Sets the input part as the part containing the potential harnesses to flatten. More...

unsafe void	CalculateLegacyComponentClocking (NXOpen.Assemblies.Component component1, NXOpen.Assemblies.Component component2, NXOpen.Formboard.FormboardManager.LegacyComponentOrientationDisplayStyle displayStyle, out NXOpen.Vector3d rotationVector, out double clockingAngle, out NXOpen.Formboard.FormboardManager.LegacyComponentOrientationConfidenceLevel confidenceLevel)
	Calculates the clocking or twist between the two components along their connecting path. More...

unsafe NXOpen.Formboard.FaceAnnotationBuilder	CreateFaceAnnotationBuilder ()
	Creates a NXOpen.Formboard.FaceAnnotationBuilder object for importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. More...

unsafe NXOpen.Formboard.FlipComponentBuilder	CreateFlipComponentBuilder ()
	Creates a NXOpen.Formboard.FlipComponentBuilder object for flipping of formboard component about an axis orthogonal to Z axis to ensure that after flipping component lies in XY plane. More...

unsafe NXOpen.Formboard.FormboardLayoutBuilder	CreateLayoutBuilder ()
	Creates a NXOpen.Formboard.FormboardLayoutBuilder that can flatten and layout new formboard geometry, or modify the layout of existing formboard geometry. More...

unsafe NXOpen.Formboard.ObjectAttributeReferenceBuilder	CreateObjectAttributeReferenceBuilder ()
	Creates a NXOpen.Formboard.ObjectAttributeReferenceBuilder that creates a tabular note object which reads values from the single object selected by the user. More...

unsafe NXOpen.Formboard.OrientBranchBuilder	CreateOrientBranchBuilder ()
	Creates a NXOpen.Formboard.OrientBranchBuilder object for rotating branches in formboard about Z axis. More...

unsafe NXOpen.Formboard.PathLengthAnnotationBuilder	CreatePathLengthAnnotationBuilder (NXOpen.Annotations.Annotation annotation)
	Creates a NXOpen.Formboard.PathLengthAnnotationBuilder More...

unsafe NXOpen.Formboard.ShapeSegmentBuilder	CreateShapeSegmentBuilder (NXOpen.Routing.ISegment segment)
	Creates a NXOpen.Formboard.ShapeSegmentBuilder that can shape formboard segments. More...

unsafe NXOpen.Formboard.UpdateFormboardBuilder	CreateUpdateFormboardBuilder ()
	Creates a NXOpen.Formboard.UpdateFormboardBuilder that compares and updates formboard geometry to match a modified master 3D harness. More...

unsafe void	GetFmbdPlaneConstraints (NXOpen.NXObject fmbdPlane, out NXOpen.Positioning.ComponentConstraint[] constraints)
	Gets NXOpen.Positioning.ComponentConstraint which are associated to the formboard plane. More...

unsafe void	HideFormboardConstraints ()
	Hides the formboard constraints. More...

unsafe bool	IsFormboard ()
	Returns whether or not the part containing this NXOpen.Formboard.FormboardManager is actually a Formboard Drawing part file. More...

unsafe void	ShowFormboardConstraints ()
	Shows all of the hidden formboard constraints. More...

unsafe void	StoreHarnessesToFlatten (NXOpen.Routing.Electrical.HarnessDevice[] harnesses)
	Examines the input list of harnesses and stores information from the harnesses into the part containing this NXOpen.Formboard.FormboardManager . More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

Contains information about flattened harness drawing and drafting data for harness manufacturing drawings (Formboard Drawings).

To obtain an instance of this class, refer to NXOpen.Routing.RouteManager

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.Formboard.FormboardManager.LegacyComponentOrientationConfidenceLevel

Returned from FormboardManager.CalculateLegacyComponentClocking as a measure of the confidence in the calculated clocking.

Enumerator
High	High confidence indicates no branches and no severe curvature in the path between the components.
Medium	Medium confidence indicates one branch or one curve with severe curvature.
Low	Low confidenceindicates more than on branch or more than on curve with severe curvature.

enum NXOpen.Formboard.FormboardManager.LegacyComponentOrientationDisplayStyle

Used by FormboardManager.CalculateLegacyComponentClocking to display extra information you can use to see how the clocking calculation is made.

Enumerator
NoDisplay	No extra display.
DisplayCurveNormals	Display the normal of each curve in the path.
DisplaySurface	Display the surface swept along the curves in the path.
DisplayAll	Display both the curve normals and surface.

Member Function Documentation

unsafe void NXOpen.Formboard.FormboardManager.AddPartAs3dHarness ( NXOpen.Part harnessPart )

inline

Sets the input part as the part containing the potential harnesses to flatten.

This method will add the input part as a new component of this assembly if there is not already an instance of the input part in the work part assembly. This method is only necessary if the reference between the formboard and it's parent 3D harness assembly has been removed.

Passing in a null reference (Nothing in Visual Basic) for the harness part will sever the link between the formboard and it's current 3D harness part file.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Parameters

harnessPart Part containing the harnesses to flatten into this part.

unsafe void NXOpen.Formboard.FormboardManager.CalculateLegacyComponentClocking	(	NXOpen.Assemblies.Component	component1,
		NXOpen.Assemblies.Component	component2,
		NXOpen.Formboard.FormboardManager.LegacyComponentOrientationDisplayStyle	displayStyle,
		out NXOpen.Vector3d	rotationVector,
		out double	clockingAngle,
		out NXOpen.Formboard.FormboardManager.LegacyComponentOrientationConfidenceLevel	confidenceLevel
	)

inline

Calculates the clocking or twist between the two components along their connecting path.

The FormboardManager.CalculateLegacyComponentClocking method uses an algorithm similar to the V1 formboard clocking calculated automatically when Routing created a formboard to find the clocking angle between two components.

First, it finds a vector representing the "up" direction on the first component.

The "up" direction is the multiport's rotate vector. If the multiport has no rotate vector, it uses the Z direction of the multiport's part.

Then, it sweeps this vector along the segments in the path connecting the two components.

Finally, it measures the angle between the swept vector and the second component's "up" vector. This angle is the clocking angle.

Throws an error if the component has no multiport or there is no path connecting the two components.

Created in NX11.0.2

License requirements: routing_harness ("Routing Harness")

Parameters

component1	The first component. The clocking of the second component is always relative to the rotation vector of the first component.
component2	The second component. The clocking of the second component is always relative to the rotation vector of the first component.
displayStyle	Various options for displaying the curve normals, surfaces, etc. Useful for debugging or explaining the results.
rotationVector	The rotation vector normal to the curve at the location of the second component's multiport.
clockingAngle	The relative angle between the rotation vector and the second component's multiport's rotate vector.
confidenceLevel	High, medium, or low confidence reflecting how many branches the path traversed or whether or not the swept surfaces had problems.

unsafe NXOpen.Formboard.FaceAnnotationBuilder NXOpen.Formboard.FormboardManager.CreateFaceAnnotationBuilder ( )

inline

Creates a NXOpen.Formboard.FaceAnnotationBuilder object for importing CGM or Pattern file geometry and placing it on a drawing sheet or model view.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe NXOpen.Formboard.FlipComponentBuilder NXOpen.Formboard.FormboardManager.CreateFlipComponentBuilder ( )

inline

Creates a NXOpen.Formboard.FlipComponentBuilder object for flipping of formboard component about an axis orthogonal to Z axis to ensure that after flipping component lies in XY plane.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe NXOpen.Formboard.FormboardLayoutBuilder NXOpen.Formboard.FormboardManager.CreateLayoutBuilder ( )

inline

Creates a NXOpen.Formboard.FormboardLayoutBuilder that can flatten and layout new formboard geometry, or modify the layout of existing formboard geometry.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe NXOpen.Formboard.ObjectAttributeReferenceBuilder NXOpen.Formboard.FormboardManager.CreateObjectAttributeReferenceBuilder ( )

inline

Creates a NXOpen.Formboard.ObjectAttributeReferenceBuilder that creates a tabular note object which reads values from the single object selected by the user.

It also creates leader for the annotation associated with the object selected by user.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe NXOpen.Formboard.OrientBranchBuilder NXOpen.Formboard.FormboardManager.CreateOrientBranchBuilder ( )

inline

Creates a NXOpen.Formboard.OrientBranchBuilder object for rotating branches in formboard about Z axis.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe NXOpen.Formboard.PathLengthAnnotationBuilder NXOpen.Formboard.FormboardManager.CreatePathLengthAnnotationBuilder ( NXOpen.Annotations.Annotation annotation )

inline

Creates a NXOpen.Formboard.PathLengthAnnotationBuilder

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Parameters

annotation The Formboard Path Length annotation.

Returns

unsafe NXOpen.Formboard.ShapeSegmentBuilder NXOpen.Formboard.FormboardManager.CreateShapeSegmentBuilder ( NXOpen.Routing.ISegment segment )

inline

Creates a NXOpen.Formboard.ShapeSegmentBuilder that can shape formboard segments.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Parameters

segment The routing segment to shape.

Returns

unsafe NXOpen.Formboard.UpdateFormboardBuilder NXOpen.Formboard.FormboardManager.CreateUpdateFormboardBuilder ( )

inline

Creates a NXOpen.Formboard.UpdateFormboardBuilder that compares and updates formboard geometry to match a modified master 3D harness.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns

unsafe void NXOpen.Formboard.FormboardManager.GetFmbdPlaneConstraints	(	NXOpen.NXObject	fmbdPlane,
		out NXOpen.Positioning.ComponentConstraint[]	constraints
	)

inline

Gets NXOpen.Positioning.ComponentConstraint which are associated to the formboard plane.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Parameters

fmbdPlane
constraints

unsafe void NXOpen.Formboard.FormboardManager.HideFormboardConstraints ( )

inline

Hides the formboard constraints.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe bool NXOpen.Formboard.FormboardManager.IsFormboard ( )

inline

Returns whether or not the part containing this NXOpen.Formboard.FormboardManager is actually a Formboard Drawing part file.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Returns: whether or not the part is a formboard.

unsafe void NXOpen.Formboard.FormboardManager.ShowFormboardConstraints ( )

inline

Shows all of the hidden formboard constraints.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe void NXOpen.Formboard.FormboardManager.StoreHarnessesToFlatten ( NXOpen.Routing.Electrical.HarnessDevice[] harnesses )

inline

Examines the input list of harnesses and stores information from the harnesses into the part containing this NXOpen.Formboard.FormboardManager .

The harnesses must from a sub-component of this part. The harnesses must form a fully-connected set of geometry. This method does not actually flatten or copy the harness geometry.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Parameters

harnesses Harnesses to flatten into this part.

Property Documentation

Tag NXOpen.Formboard.FormboardManager.Tag

get

Returns the tag of this object.

The documentation for this class was generated from the following file:

Formboard_FormboardManager.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation