NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Formboard::FormboardManager Class Reference

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

Public Member Functions

void AddPartAs3dHarness (NXOpen::Part *harnessPart)
 Sets the input part as the part containing the potential harnesses to flatten. More...
 
NXOpen::Formboard::FaceAnnotationBuilderCreateFaceAnnotationBuilder ()
 Creates a NXOpen::Formboard::FaceAnnotationBuilder object for importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. More...
 
NXOpen::Formboard::FlipComponentBuilderCreateFlipComponentBuilder ()
 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...
 
NXOpen::Formboard::FormboardLayoutBuilderCreateLayoutBuilder ()
 Creates a NXOpen::Formboard::FormboardLayoutBuilder that can flatten and layout new formboard geometry, or modify the layout of existing formboard geometry. More...
 
NXOpen::Formboard::ObjectAttributeReferenceBuilderCreateObjectAttributeReferenceBuilder ()
 Creates a NXOpen::Formboard::ObjectAttributeReferenceBuilder that creates a tabular note object which reads values from the single object selected by the user. More...
 
NXOpen::Formboard::OrientBranchBuilderCreateOrientBranchBuilder ()
 Creates a NXOpen::Formboard::OrientBranchBuilder object for rotating branches in formboard about Z axis. More...
 
NXOpen::Formboard::PathLengthAnnotationBuilderCreatePathLengthAnnotationBuilder (NXOpen::Annotations::Annotation *annotation)
 Creates a NXOpen::Formboard::PathLengthAnnotationBuilder. More...
 
NXOpen::Formboard::ShapeSegmentBuilderCreateShapeSegmentBuilder (NXOpen::Routing::ISegment *segment)
 Creates a NXOpen::Formboard::ShapeSegmentBuilder that can shape formboard segments. More...
 
NXOpen::Formboard::UpdateFormboardBuilderCreateUpdateFormboardBuilder ()
 Creates a NXOpen::Formboard::UpdateFormboardBuilder that compares and updates formboard geometry to match a modified master 3D harness. More...
 
void GetFmbdPlaneConstraints (NXOpen::NXObject *fmbdPlane, std::vector< NXOpen::Positioning::ComponentConstraint * > &constraints)
 Gets NXOpen::Positioning::ComponentConstraint which are associated to the formboard plane. More...
 
void HideFormboardConstraints ()
 Hides the formboard constraints. More...
 
bool IsFormboard ()
 Returns whether or not the part containing this NXOpen::Formboard::FormboardManager is actually a Formboard Drawing part file. More...
 
void ShowFormboardConstraints ()
 Shows all of the hidden formboard constraints. More...
 
void StoreHarnessesToFlatten (const std::vector< 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...
 
tag_t Tag () const
 Returns the tag of this object. 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 Function Documentation

void NXOpen::Formboard::FormboardManager::AddPartAs3dHarness ( NXOpen::Part harnessPart)

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 NULL 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
harnessPartPart containing the harnesses to flatten into this part.
NXOpen::Formboard::FaceAnnotationBuilder* NXOpen::Formboard::FormboardManager::CreateFaceAnnotationBuilder ( )

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

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
NXOpen::Formboard::FlipComponentBuilder* NXOpen::Formboard::FormboardManager::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.

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
NXOpen::Formboard::FormboardLayoutBuilder* NXOpen::Formboard::FormboardManager::CreateLayoutBuilder ( )

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

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
NXOpen::Formboard::ObjectAttributeReferenceBuilder* NXOpen::Formboard::FormboardManager::CreateObjectAttributeReferenceBuilder ( )

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.

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
NXOpen::Formboard::OrientBranchBuilder* NXOpen::Formboard::FormboardManager::CreateOrientBranchBuilder ( )

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

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
NXOpen::Formboard::PathLengthAnnotationBuilder* NXOpen::Formboard::FormboardManager::CreatePathLengthAnnotationBuilder ( NXOpen::Annotations::Annotation annotation)

Creates a NXOpen::Formboard::PathLengthAnnotationBuilder.

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
Parameters
annotationThe Formboard Path Length annotation.
NXOpen::Formboard::ShapeSegmentBuilder* NXOpen::Formboard::FormboardManager::CreateShapeSegmentBuilder ( NXOpen::Routing::ISegment segment)

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

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
Parameters
segmentThe routing segment to shape.
NXOpen::Formboard::UpdateFormboardBuilder* NXOpen::Formboard::FormboardManager::CreateUpdateFormboardBuilder ( )

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

Returns

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
void NXOpen::Formboard::FormboardManager::GetFmbdPlaneConstraints ( NXOpen::NXObject fmbdPlane,
std::vector< NXOpen::Positioning::ComponentConstraint * > &  constraints 
)

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


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters
fmbdPlanefmbdplane
constraintsconstraints
void NXOpen::Formboard::FormboardManager::HideFormboardConstraints ( )

Hides the formboard constraints.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

bool NXOpen::Formboard::FormboardManager::IsFormboard ( )

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

Returns
whether or not the part is a formboard.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")
void NXOpen::Formboard::FormboardManager::ShowFormboardConstraints ( )

Shows all of the hidden formboard constraints.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::FormboardManager::StoreHarnessesToFlatten ( const std::vector< 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 .

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
harnessesHarnesses to flatten into this part.
tag_t NXOpen::Formboard::FormboardManager::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.