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

Represents the SimKimJunctionBuilder class object. More...

Inheritance diagram for NXOpen::SIM::KinematicJunctionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SystemClass {
  SystemClassNone, SystemClassMount, SystemClassMachineZero, SystemClassToolZero,
  SystemClassToolTip, SystemClassLatheWpZx, SystemClassLatheWpXy
}
 The junction system classes. More...
 

Public Member Functions

NXOpen::SIM::KinematicJunctionBuilder::SystemClass Classification ()
 Returns the classification of the junction
Created in NX7.5.0. More...
 
NXOpen::CartesianCoordinateSystemCreateDefaultCsys ()
 Create the default CSYS based on WCS. More...
 
NXOpen::CartesianCoordinateSystemCreateTooltipCsys ()
 Create the tooltip CSYS. More...
 
NXOpen::CartesianCoordinateSystemCsys ()
 Returns the CSYS associated with the junction
Created in NX7.5.0. More...
 
bool IsMachineZero ()
 Test if this is a machine zero junction. More...
 
bool IsToolMount ()
 Test if the junction is a tool mount junctions. More...
 
bool IsToolTip ()
 Test if the junction is a tool tip junctions. More...
 
NXString Name ()
 Returns the kim junction's name
Created in NX7.5.0. More...
 
void SetClassification (NXOpen::SIM::KinematicJunctionBuilder::SystemClass jctClass)
 Sets the classification of the junction
Created in NX7.5.0. More...
 
void SetCsys (NXOpen::CartesianCoordinateSystem *csys)
 Sets the CSYS associated with the junction
Created in NX7.5.0. More...
 
void SetName (const NXString &name)
 Sets the kim junction's name
Created in NX7.5.0. More...
 
void SetName (const char *name)
 Sets the kim junction's name
Created in NX7.5.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

Represents the SimKimJunctionBuilder class object.


Use the NXOpen::SIM::KinematicConfigurator class to create a KinematicJunctionBuilder object.

Created in NX7.5.0.

Member Enumeration Documentation

The junction system classes.

Enumerator
SystemClassNone 

no specal class

SystemClassMount 

a mounting junction

SystemClassMachineZero 

the machine zero junction

SystemClassToolZero 

the tool mounting point

SystemClassToolTip 

The tool tip junction.

SystemClassLatheWpZx 

Lathe Work Plane Z/X.

SystemClassLatheWpXy 

Lathe Work Plane X/Y.

Member Function Documentation

NXOpen::SIM::KinematicJunctionBuilder::SystemClass NXOpen::SIM::KinematicJunctionBuilder::Classification ( )

Returns the classification of the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

NXOpen::CartesianCoordinateSystem* NXOpen::SIM::KinematicJunctionBuilder::CreateDefaultCsys ( )

Create the default CSYS based on WCS.

Returns
the default csys
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")
NXOpen::CartesianCoordinateSystem* NXOpen::SIM::KinematicJunctionBuilder::CreateTooltipCsys ( )

Create the tooltip CSYS.

Returns
the tooltip csys
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
NXOpen::CartesianCoordinateSystem* NXOpen::SIM::KinematicJunctionBuilder::Csys ( )

Returns the CSYS associated with the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

bool NXOpen::SIM::KinematicJunctionBuilder::IsMachineZero ( )

Test if this is a machine zero junction.

Returns
true if it is the machine zero junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
bool NXOpen::SIM::KinematicJunctionBuilder::IsToolMount ( )

Test if the junction is a tool mount junctions.

Returns
true if it is a tool mount junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")
bool NXOpen::SIM::KinematicJunctionBuilder::IsToolTip ( )

Test if the junction is a tool tip junctions.

Returns
true if it is a tool tip junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")
NXString NXOpen::SIM::KinematicJunctionBuilder::Name ( )

Returns the kim junction's name
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

void NXOpen::SIM::KinematicJunctionBuilder::SetClassification ( NXOpen::SIM::KinematicJunctionBuilder::SystemClass  jctClass)

Sets the classification of the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

Parameters
jctClassthe classification of the junction
void NXOpen::SIM::KinematicJunctionBuilder::SetCsys ( NXOpen::CartesianCoordinateSystem csys)

Sets the CSYS associated with the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

Parameters
csysthe csys
void NXOpen::SIM::KinematicJunctionBuilder::SetName ( const NXString name)

Sets the kim junction's name
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

Parameters
namethe junction's new name
void NXOpen::SIM::KinematicJunctionBuilder::SetName ( const char *  name)

Sets the kim junction's name
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")

Parameters
namethe junction's new name

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