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

Represents a Routing::AlignStockBuilder Builder for aligning non-circular stocks. More...

Inheritance diagram for NXOpen::Routing::AlignStockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  StockAlignmentMethod { StockAlignmentMethodRoutingObject, StockAlignmentMethodVectorToVector }
 Methods of aligning stocks. More...
 

Public Member Functions

NXOpen::Routing::AlignStockBuilder::StockAlignmentMethod AlignmentMethod ()
 Returns the alignment method. More...
 
NXOpen::Routing::RouteObjectCollectorReferenceObject ()
 Returns the reference object. More...
 
NXOpen::DirectionReferenceVector ()
 Returns the reference vector. More...
 
void SetAlignmentMethod (NXOpen::Routing::AlignStockBuilder::StockAlignmentMethod alignmentMethod)
 Sets the alignment method. More...
 
void SetReferenceVector (NXOpen::Direction *toVector)
 Sets the reference vector. More...
 
void SetTargetVector (NXOpen::Direction *fromVector)
 Sets the target vector. More...
 
NXOpen::Routing::RouteObjectCollectorStocksToAlign ()
 Returns a collection of stocks to align. More...
 
NXOpen::DirectionTargetVector ()
 Returns the target vector. 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

Represents a Routing::AlignStockBuilder Builder for aligning non-circular stocks.

Two methods are provided to user to make stocks alignment: Routing Object: specify the referencing routing object and deriving the reference rotate vector from it, Vector to Vector: specify the to vector as reference and the from vector as the target, then align them.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateAlignStockBuilder
Default values.

Property Value

AlignmentMethod

RoutingObject


Created in NX9.0.3.

Member Enumeration Documentation

Methods of aligning stocks.

Enumerator
StockAlignmentMethodRoutingObject 

routing object

StockAlignmentMethodVectorToVector 

vector to vector

Member Function Documentation

NXOpen::Routing::AlignStockBuilder::StockAlignmentMethod NXOpen::Routing::AlignStockBuilder::AlignmentMethod ( )

Returns the alignment method.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::AlignStockBuilder::ReferenceObject ( )

Returns the reference object.

The reference object could be a stock or a qualified part.
Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

NXOpen::Direction* NXOpen::Routing::AlignStockBuilder::ReferenceVector ( )

Returns the reference vector.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::AlignStockBuilder::SetAlignmentMethod ( NXOpen::Routing::AlignStockBuilder::StockAlignmentMethod  alignmentMethod)

Sets the alignment method.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

Parameters
alignmentMethodalignmentmethod
void NXOpen::Routing::AlignStockBuilder::SetReferenceVector ( NXOpen::Direction toVector)

Sets the reference vector.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

Parameters
toVectortovector
void NXOpen::Routing::AlignStockBuilder::SetTargetVector ( NXOpen::Direction fromVector)

Sets the target vector.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

Parameters
fromVectorfromvector
NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::AlignStockBuilder::StocksToAlign ( )

Returns a collection of stocks to align.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")

NXOpen::Direction* NXOpen::Routing::AlignStockBuilder::TargetVector ( )

Returns the target vector.


Created in NX9.0.3.

License requirements : routing_base ("Routing Basic")


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