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

Defines the various options for determining the rounded lengths of formboard geometry during the layout or update process. More...

Inheritance diagram for NXOpen::Formboard::LayoutLengthOptions:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RoundingMethod { RoundingMethodExact, RoundingMethodNearest, RoundingMethodUpToNearest, RoundingMethodDownToNearest }
 Methods of rounding lengths for Formboard geometry. More...
 

Public Member Functions

NXOpen::ExpressionNetlistLengthIncrement ()
 Returns the connection list length increment. More...
 
NXOpen::Formboard::LayoutLengthOptions::RoundingMethod NetlistRoundingMethod ()
 Returns the rounding method to apply to Connection List lengths. More...
 
NXOpen::ExpressionOverstockLengthIncrement ()
 Returns the overstock length increment. More...
 
NXOpen::Formboard::LayoutLengthOptions::RoundingMethod OverstockRoundingMethod ()
 Returns the rounding method to apply to overstock wrapped lengths. More...
 
NXOpen::ExpressionSegmentLengthIncrement ()
 Returns the segment length increment. More...
 
NXOpen::Formboard::LayoutLengthOptions::RoundingMethod SegmentRoundingMethod ()
 Returns the rounding method to apply to segment lengths. More...
 
void SetNetlistRoundingMethod (NXOpen::Formboard::LayoutLengthOptions::RoundingMethod netlistRoundingMethod)
 Sets the rounding method to apply to Connection List lengths. More...
 
void SetOverstockRoundingMethod (NXOpen::Formboard::LayoutLengthOptions::RoundingMethod overstockRoundingMethod)
 Sets the rounding method to apply to overstock wrapped lengths. More...
 
void SetSegmentRoundingMethod (NXOpen::Formboard::LayoutLengthOptions::RoundingMethod segmentRoundingMethod)
 Sets the rounding method to apply to segment lengths. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Defines the various options for determining the rounded lengths of formboard geometry during the layout or update process.


Created automatically by containing classes.

Created in NX7.5.0.

Member Enumeration Documentation

Methods of rounding lengths for Formboard geometry.

The rounding method determines the value of the length in the Formboard by modifying the original length values from the 3D harness part file.

Enumerator
RoundingMethodExact 

Lengths are unmodified.

RoundingMethodNearest 

Lengths are rounded up or down to the nearest increment value.

RoundingMethodUpToNearest 

Lengths are rounded up to the nearest increment value.

RoundingMethodDownToNearest 

Lengths are rounded down to the nearest increment value.

Member Function Documentation

NXOpen::Expression* NXOpen::Formboard::LayoutLengthOptions::NetlistLengthIncrement ( )

Returns the connection list length increment.

Only used when the Formboard::LayoutLengthOptions::NetlistRoundingMethod and Formboard::LayoutLengthOptions::SetNetlistRoundingMethod is Formboard::LayoutLengthOptions::RoundingMethodUpToNearest or Formboard::LayoutLengthOptions::RoundingMethodDownToNearest .


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::LayoutLengthOptions::RoundingMethod NXOpen::Formboard::LayoutLengthOptions::NetlistRoundingMethod ( )

Returns the rounding method to apply to Connection List lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::LayoutLengthOptions::OverstockLengthIncrement ( )
NXOpen::Formboard::LayoutLengthOptions::RoundingMethod NXOpen::Formboard::LayoutLengthOptions::OverstockRoundingMethod ( )

Returns the rounding method to apply to overstock wrapped lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::LayoutLengthOptions::SegmentLengthIncrement ( )
NXOpen::Formboard::LayoutLengthOptions::RoundingMethod NXOpen::Formboard::LayoutLengthOptions::SegmentRoundingMethod ( )

Returns the rounding method to apply to segment lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::LayoutLengthOptions::SetNetlistRoundingMethod ( NXOpen::Formboard::LayoutLengthOptions::RoundingMethod  netlistRoundingMethod)

Sets the rounding method to apply to Connection List lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters
netlistRoundingMethodnetlistroundingmethod
void NXOpen::Formboard::LayoutLengthOptions::SetOverstockRoundingMethod ( NXOpen::Formboard::LayoutLengthOptions::RoundingMethod  overstockRoundingMethod)

Sets the rounding method to apply to overstock wrapped lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters
overstockRoundingMethodoverstockroundingmethod
void NXOpen::Formboard::LayoutLengthOptions::SetSegmentRoundingMethod ( NXOpen::Formboard::LayoutLengthOptions::RoundingMethod  segmentRoundingMethod)

Sets the rounding method to apply to segment lengths.


Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters
segmentRoundingMethodsegmentroundingmethod

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