NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Routing::QualifyPortBuilder Class Reference

Builder for creating/editing ports. More...

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

Public Types

enum  CreatePortType { CreatePortTypeFitting, CreatePortTypeFixture, CreatePortTypeMulti }
 Determines the port type to create. More...
 

Public Member Functions

NXOpen::DirectionAlignVector ()
 Returns the align vector
Created in NX1847.0.0. More...
 
bool AlignVectorUserDefined ()
 Returns the align vector user defined
Created in NX1847.0.0. More...
 
bool AllowMultiConnections ()
 Returns the allow multiple connections
Created in NX1847.0.0. More...
 
bool AllowPortEngagement ()
 Returns the allow port engagement
Created in NX1847.0.0. More...
 
NXOpen::ExpressionBackExtension ()
 Returns the back extension
Created in NX1847.0.0. More...
 
NXOpen::ExpressionClockingAngle ()
 Returns the clocking angle
Created in NX1847.0.0. More...
 
NXOpen::ExpressionCutbackLength ()
 Returns the cutback length
Created in NX1847.0.0. More...
 
NXOpen::Routing::Port::FlowDirectionType FlowDirection ()
 Returns the flow direction
Created in NX1847.0.0. More...
 
NXOpen::ExpressionLengthAddition ()
 Returns the length addition
Created in NX1847.0.0. More...
 
NXString OffsetExpression ()
 Returns the offset expression
Created in NX1847.0.0. More...
 
NXOpen::DirectionOffsetVector ()
 Returns the offset vector
Created in NX1847.0.0. More...
 
bool OffsetVectorUserDefined ()
 Returns the offset vector user defined
Created in NX1847.0.0. More...
 
NXOpen::PointOriginPoint ()
 Returns the origin point
Created in NX1847.0.0. More...
 
NXOpen::ExpressionPortEngagement ()
 Returns the port engagement
Created in NX1847.0.0. More...
 
NXOpen::ExpressionPortExtension ()
 Returns the port extension
Created in NX1847.0.0. More...
 
NXString PortNameString ()
 Returns the port name string
Created in NX1847.0.0. More...
 
NXOpen::Routing::QualifyPortBuilder::CreatePortType PortType ()
 Returns the port type
Created in NX1847.0.0. More...
 
NXOpen::DirectionRotationVector ()
 Returns the rotation vector
Created in NX1847.0.0. More...
 
void SetAlignVector (NXOpen::Direction *alignVector)
 Sets the align vector
Created in NX1847.0.0. More...
 
void SetAlignVectorUserDefined (bool alignVectorUserDefined)
 Sets the align vector user defined
Created in NX1847.0.0. More...
 
void SetAllowMultiConnections (bool multiConnections)
 Sets the allow multiple connections
Created in NX1847.0.0. More...
 
void SetAllowPortEngagement (bool allowPortEngagement)
 Sets the allow port engagement
Created in NX1847.0.0. More...
 
void SetBackExtension (NXOpen::Expression *backExtension)
 Sets the back extension
Created in NX1847.0.0. More...
 
void SetCutbackLength (NXOpen::Expression *cutbackLength)
 Sets the cutback length
Created in NX1847.0.0. More...
 
void SetFlowDirection (NXOpen::Routing::Port::FlowDirectionType flowDirection)
 Sets the flow direction
Created in NX1847.0.0. More...
 
void SetLengthAddition (NXOpen::Expression *lengthAddition)
 Sets the length addition
Created in NX1847.0.0. More...
 
void SetOffsetExpression (const NXString &offsetExpression)
 Sets the offset expression
Created in NX1847.0.0. More...
 
void SetOffsetExpression (const char *offsetExpression)
 Sets the offset expression
Created in NX1847.0.0. More...
 
void SetOffsetVector (NXOpen::Direction *offsetVector)
 Sets the offset vector
Created in NX1847.0.0. More...
 
void SetOffsetVectorUserDefined (bool offsetVectorUserDefined)
 Sets the offset vector user defined
Created in NX1847.0.0. More...
 
void SetOriginPoint (NXOpen::Point *originPoint)
 Sets the origin point
Created in NX1847.0.0. More...
 
void SetPortEngagement (NXOpen::Expression *portEngagement)
 Sets the port engagement
Created in NX1847.0.0. More...
 
void SetPortExtension (NXOpen::Expression *portExtension)
 Sets the port extension
Created in NX1847.0.0. More...
 
void SetPortNameString (const NXString &portNameString)
 Sets the port name string
Created in NX1847.0.0. More...
 
void SetPortNameString (const char *portNameString)
 Sets the port name string
Created in NX1847.0.0. More...
 
void SetPortType (NXOpen::Routing::QualifyPortBuilder::CreatePortType portType)
 Sets the port type
Created in NX1847.0.0. More...
 
void SetRotationVector (NXOpen::Direction *rotationVector)
 Sets the rotation vector
Created in NX1847.0.0. More...
 
void SetSpoolDelimiter (bool spoolDelimiter)
 Sets the spool delimiter
Created in NX1847.0.0. More...
 
void SetStockOffset (bool stockOffset)
 Sets the stock offset
Created in NX1847.0.0. More...
 
bool SpoolDelimiter ()
 Returns the spool delimiter
Created in NX1847.0.0. More...
 
bool StockOffset ()
 Returns the stock offset
Created in NX1847.0.0. 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

Builder for creating/editing ports.


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateQualifyPortBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

Determines the port type to create.

Enumerator
CreatePortTypeFitting 

Fitting Port.

CreatePortTypeFixture 

Fixture Port.

CreatePortTypeMulti 

Multi Port.

Member Function Documentation

NXOpen::Direction* NXOpen::Routing::QualifyPortBuilder::AlignVector ( )

Returns the align vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::QualifyPortBuilder::AlignVectorUserDefined ( )

Returns the align vector user defined
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::QualifyPortBuilder::AllowMultiConnections ( )

Returns the allow multiple connections
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::QualifyPortBuilder::AllowPortEngagement ( )

Returns the allow port engagement
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::BackExtension ( )

Returns the back extension
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::ClockingAngle ( )

Returns the clocking angle
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::CutbackLength ( )

Returns the cutback length
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Routing::Port::FlowDirectionType NXOpen::Routing::QualifyPortBuilder::FlowDirection ( )

Returns the flow direction
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::LengthAddition ( )

Returns the length addition
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::QualifyPortBuilder::OffsetExpression ( )

Returns the offset expression
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Direction* NXOpen::Routing::QualifyPortBuilder::OffsetVector ( )

Returns the offset vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::QualifyPortBuilder::OffsetVectorUserDefined ( )

Returns the offset vector user defined
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Point* NXOpen::Routing::QualifyPortBuilder::OriginPoint ( )

Returns the origin point
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::PortEngagement ( )

Returns the port engagement
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QualifyPortBuilder::PortExtension ( )

Returns the port extension
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::QualifyPortBuilder::PortNameString ( )

Returns the port name string
Created in NX1847.0.0.



License requirements : None

NXOpen::Routing::QualifyPortBuilder::CreatePortType NXOpen::Routing::QualifyPortBuilder::PortType ( )

Returns the port type
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Direction* NXOpen::Routing::QualifyPortBuilder::RotationVector ( )

Returns the rotation vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::QualifyPortBuilder::SetAlignVector ( NXOpen::Direction alignVector)

Sets the align vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
alignVectoralignvector
void NXOpen::Routing::QualifyPortBuilder::SetAlignVectorUserDefined ( bool  alignVectorUserDefined)

Sets the align vector user defined
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
alignVectorUserDefinedalignvectoruserdefined
void NXOpen::Routing::QualifyPortBuilder::SetAllowMultiConnections ( bool  multiConnections)

Sets the allow multiple connections
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
multiConnectionsmulticonnections
void NXOpen::Routing::QualifyPortBuilder::SetAllowPortEngagement ( bool  allowPortEngagement)

Sets the allow port engagement
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
allowPortEngagementallowportengagement
void NXOpen::Routing::QualifyPortBuilder::SetBackExtension ( NXOpen::Expression backExtension)

Sets the back extension
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
backExtensionbackextension
void NXOpen::Routing::QualifyPortBuilder::SetCutbackLength ( NXOpen::Expression cutbackLength)

Sets the cutback length
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
cutbackLengthcutbacklength
void NXOpen::Routing::QualifyPortBuilder::SetFlowDirection ( NXOpen::Routing::Port::FlowDirectionType  flowDirection)

Sets the flow direction
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
flowDirectionflowdirection
void NXOpen::Routing::QualifyPortBuilder::SetLengthAddition ( NXOpen::Expression lengthAddition)

Sets the length addition
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
lengthAdditionlengthaddition
void NXOpen::Routing::QualifyPortBuilder::SetOffsetExpression ( const NXString offsetExpression)

Sets the offset expression
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
offsetExpressionoffsetexpression
void NXOpen::Routing::QualifyPortBuilder::SetOffsetExpression ( const char *  offsetExpression)

Sets the offset expression
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
offsetExpressionoffsetexpression
void NXOpen::Routing::QualifyPortBuilder::SetOffsetVector ( NXOpen::Direction offsetVector)

Sets the offset vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
offsetVectoroffsetvector
void NXOpen::Routing::QualifyPortBuilder::SetOffsetVectorUserDefined ( bool  offsetVectorUserDefined)

Sets the offset vector user defined
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
offsetVectorUserDefinedoffsetvectoruserdefined
void NXOpen::Routing::QualifyPortBuilder::SetOriginPoint ( NXOpen::Point originPoint)

Sets the origin point
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
originPointoriginpoint
void NXOpen::Routing::QualifyPortBuilder::SetPortEngagement ( NXOpen::Expression portEngagement)

Sets the port engagement
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
portEngagementportengagement
void NXOpen::Routing::QualifyPortBuilder::SetPortExtension ( NXOpen::Expression portExtension)

Sets the port extension
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
portExtensionportextension
void NXOpen::Routing::QualifyPortBuilder::SetPortNameString ( const NXString portNameString)

Sets the port name string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
portNameStringportnamestring
void NXOpen::Routing::QualifyPortBuilder::SetPortNameString ( const char *  portNameString)

Sets the port name string
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
portNameStringportnamestring
void NXOpen::Routing::QualifyPortBuilder::SetPortType ( NXOpen::Routing::QualifyPortBuilder::CreatePortType  portType)

Sets the port type
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
portTypeporttype
void NXOpen::Routing::QualifyPortBuilder::SetRotationVector ( NXOpen::Direction rotationVector)

Sets the rotation vector
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
rotationVectorrotationvector
void NXOpen::Routing::QualifyPortBuilder::SetSpoolDelimiter ( bool  spoolDelimiter)

Sets the spool delimiter
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
spoolDelimiterspooldelimiter
void NXOpen::Routing::QualifyPortBuilder::SetStockOffset ( bool  stockOffset)

Sets the stock offset
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
stockOffsetstockoffset
bool NXOpen::Routing::QualifyPortBuilder::SpoolDelimiter ( )

Returns the spool delimiter
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::QualifyPortBuilder::StockOffset ( )

Returns the stock offset
Created in NX1847.0.0.



License requirements : routing_base ("Routing Basic")


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