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

Represents a OrientGeom Builder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::OrientGeomBuilder:
NXOpen::CAM::NCGroupBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::MillOrientGeomBuilder NXOpen::CAM::TurnOrientGeomBuilder NXOpen::CAM::WedmOrientGeomBuilder

Public Types

enum  CsysPurposeModes { CsysPurposeModesLocal, CsysPurposeModesMain }
 The CSYS purpose mode options
Created in NX5.0.0. More...
 
enum  SpecialOutputModes { SpecialOutputModesNone, SpecialOutputModesUseMainMcs, SpecialOutputModesFixtureOffset, SpecialOutputModesCsysRotation }
 The special output mode options
Created in NX5.0.0. More...
 
enum  ToolAxisModes { ToolAxisModesPositiveZOfMcs, ToolAxisModesFixedAxis, ToolAxisModesAllAxes }
 the tool axis mode options More...
 

Public Member Functions

NXOpen::CAM::InheritableIntBuilderFixtureOffsetBuilder ()
 Returns the Fixture Offset builder
Created in NX5.0.0. More...
 
NXOpen::CAM::OrientGeomBuilder::CsysPurposeModes GetCsysPurposeMode ()
 Returns the CSYS purpose. More...
 
NXOpen::CAM::OrientGeomBuilder::SpecialOutputModes GetSpecialOutputMode ()
 Returns the Special Output. More...
 
NXOpen::CAM::OrientGeomBuilder::ToolAxisModes GetToolAxisMode ()
 Returns the tool axis mode. More...
 
NXOpen::CAM::LayoutCiBuilderLayoutCiBuilder ()
 Returns the Save Layer/Layout builder
Created in NX5.0.0. More...
 
bool LinkRcsToMcs ()
 Returns the link RCS to MCS
Created in NX5.0.0. More...
 
NXOpen::CartesianCoordinateSystemMcs ()
 Returns the MCS
Created in NX5.0.0. More...
 
NXOpen::CartesianCoordinateSystemRcs ()
 Returns the RCS
Created in NX5.0.0. More...
 
void SetCsysPurposeMode (NXOpen::CAM::OrientGeomBuilder::CsysPurposeModes csysPurposeMode)
 Sets the CSYS purpose
Created in NX5.0.0. More...
 
void SetLinkRcsToMcs (bool linkRcsToMcs)
 Sets the link RCS to MCS
Created in NX5.0.0. More...
 
void SetMcs (NXOpen::CartesianCoordinateSystem *mcs)
 Sets the MCS
Created in NX5.0.0. More...
 
void SetRcs (NXOpen::CartesianCoordinateSystem *rcs)
 Sets the RCS
Created in NX5.0.0. More...
 
void SetSpecialOutputMode (NXOpen::CAM::OrientGeomBuilder::SpecialOutputModes specialOutputMode)
 Sets the Special Output
Created in NX5.0.0. More...
 
void SetToolAxisMode (NXOpen::CAM::OrientGeomBuilder::ToolAxisModes toolAxisMode)
 Sets the tool axis mode
Created in NX5.0.0. More...
 
void SetToolAxisVector (NXOpen::NXObject *toolAxisVector)
 Sets the tool axis vector
Created in NX5.0.0. More...
 
NXOpen::NXObjectToolAxisVector ()
 Returns the tool axis vector
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NCGroupBuilder
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.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

Represents a OrientGeom Builder
This is an abstract class, and cannot be instantiated.



Created in NX5.0.0.

Member Enumeration Documentation

The CSYS purpose mode options
Created in NX5.0.0.


Enumerator
CsysPurposeModesLocal 

CSYS purpose mode: Local.

CsysPurposeModesMain 

CSYS purpose mode: Main.

The special output mode options
Created in NX5.0.0.


Enumerator
SpecialOutputModesNone 

Special output mode: None.

SpecialOutputModesUseMainMcs 

Special output mode: Use main MCS.

SpecialOutputModesFixtureOffset 

Special output mode: Fixture offset.

SpecialOutputModesCsysRotation 

Special output mode: CSYS rotation.

the tool axis mode options

Enumerator
ToolAxisModesPositiveZOfMcs 

Tool axis mode: +Z of MCS.

ToolAxisModesFixedAxis 

Tool axis mode: Fixed axis.

ToolAxisModesAllAxes 

Tool axis mode: All axes.

Member Function Documentation

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::OrientGeomBuilder::FixtureOffsetBuilder ( )

Returns the Fixture Offset builder
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::OrientGeomBuilder::CsysPurposeModes NXOpen::CAM::OrientGeomBuilder::GetCsysPurposeMode ( )

Returns the CSYS purpose.

Returns
the CSYS purpose mode
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::OrientGeomBuilder::SpecialOutputModes NXOpen::CAM::OrientGeomBuilder::GetSpecialOutputMode ( )

Returns the Special Output.

Returns
the special output mode
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::OrientGeomBuilder::ToolAxisModes NXOpen::CAM::OrientGeomBuilder::GetToolAxisMode ( )

Returns the tool axis mode.

Returns
the integer value
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::LayoutCiBuilder* NXOpen::CAM::OrientGeomBuilder::LayoutCiBuilder ( )

Returns the Save Layer/Layout builder
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::OrientGeomBuilder::LinkRcsToMcs ( )

Returns the link RCS to MCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CartesianCoordinateSystem* NXOpen::CAM::OrientGeomBuilder::Mcs ( )

Returns the MCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CartesianCoordinateSystem* NXOpen::CAM::OrientGeomBuilder::Rcs ( )

Returns the RCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::OrientGeomBuilder::SetCsysPurposeMode ( NXOpen::CAM::OrientGeomBuilder::CsysPurposeModes  csysPurposeMode)

Sets the CSYS purpose
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
csysPurposeModethe CSYS purpose mode
void NXOpen::CAM::OrientGeomBuilder::SetLinkRcsToMcs ( bool  linkRcsToMcs)

Sets the link RCS to MCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
linkRcsToMcsthe link RCS to MCS value
void NXOpen::CAM::OrientGeomBuilder::SetMcs ( NXOpen::CartesianCoordinateSystem mcs)

Sets the MCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
mcsthe MCS
void NXOpen::CAM::OrientGeomBuilder::SetRcs ( NXOpen::CartesianCoordinateSystem rcs)

Sets the RCS
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
rcsthe MCS
void NXOpen::CAM::OrientGeomBuilder::SetSpecialOutputMode ( NXOpen::CAM::OrientGeomBuilder::SpecialOutputModes  specialOutputMode)

Sets the Special Output
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
specialOutputModethe special output mode
void NXOpen::CAM::OrientGeomBuilder::SetToolAxisMode ( NXOpen::CAM::OrientGeomBuilder::ToolAxisModes  toolAxisMode)

Sets the tool axis mode
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
toolAxisModethe integer value
void NXOpen::CAM::OrientGeomBuilder::SetToolAxisVector ( NXOpen::NXObject toolAxisVector)

Sets the tool axis vector
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
toolAxisVectorthe vector tag
NXOpen::NXObject* NXOpen::CAM::OrientGeomBuilder::ToolAxisVector ( )

Returns the tool axis vector
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")


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