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

Represents cam session
To obtain an instance of this class, refer to NXOpen::Session

Created in NX4.0.0. More...

Public Types

enum  ObjectSubtype {
  ObjectSubtypeSetup, ObjectSubtypeOperation, ObjectSubtypeProgram, ObjectSubtypeTool,
  ObjectSubtypeMethod, ObjectSubtypeGeometry
}
 the template subtype class More...
 

Public Member Functions

NXOpen::CAM::PreferencesCreateCamPreferences ()
 Create Cam Preferences builder. More...
 
bool GetMcsDisplay ()
 Get MCS display. More...
 
std::vector< NXStringGetTemplateSubtypes (const NXString &typeName, NXOpen::CAM::CAMSession::ObjectSubtype subtypeClass)
 Get the names of the available template subypes for the specified template type. More...
 
std::vector< NXStringGetTemplateSubtypes (const char *typeName, NXOpen::CAM::CAMSession::ObjectSubtype subtypeClass)
 Get the names of the available template subypes for the specified template type. More...
 
std::vector< NXStringGetTemplateTypes ()
 Get the names of the available template types. More...
 
NXOpen::CAM::PathDisplayPathDisplay ()
 Returns the NXOpen::CAM::PathDisplay belonging to this cam session
Created in NX10.0.2. More...
 
void SetMcsDisplay (bool displayMCS)
 Set MCS display
Created in NX8.0.1. More...
 
void SpecifyConfiguration (const NXString &configFile)
 Specify the configuration file of the current cam session
Created in NX4.0.0. More...
 
void SpecifyConfiguration (const char *configFile)
 Specify the configuration file of the current cam session
Created in NX4.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents cam session
To obtain an instance of this class, refer to NXOpen::Session

Created in NX4.0.0.


Member Enumeration Documentation

the template subtype class

Enumerator
ObjectSubtypeSetup 

Setup.

ObjectSubtypeOperation 

Operations.

ObjectSubtypeProgram 

NC Program.

ObjectSubtypeTool 

Machine Tools and Cutters.

ObjectSubtypeMethod 

Machining Method.

ObjectSubtypeGeometry 

Geometry.

Member Function Documentation

NXOpen::CAM::Preferences* NXOpen::CAM::CAMSession::CreateCamPreferences ( )

Create Cam Preferences builder.

Returns
created cam preferences builder
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")
bool NXOpen::CAM::CAMSession::GetMcsDisplay ( )

Get MCS display.

Returns
whether the MCS should be displayed
Created in NX8.0.1.

License requirements : None
std::vector<NXString> NXOpen::CAM::CAMSession::GetTemplateSubtypes ( const NXString typeName,
NXOpen::CAM::CAMSession::ObjectSubtype  subtypeClass 
)

Get the names of the available template subypes for the specified template type.

Only those subtypes have the specified subtype class are returned.

Returns
the names of available subtypes
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters
typeNamethe name of the template type
subtypeClassthe subtype class
std::vector<NXString> NXOpen::CAM::CAMSession::GetTemplateSubtypes ( const char *  typeName,
NXOpen::CAM::CAMSession::ObjectSubtype  subtypeClass 
)

Get the names of the available template subypes for the specified template type.

Only those subtypes have the specified subtype class are returned.

Returns
the names of available subtypes
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
Parameters
typeNamethe name of the template type
subtypeClassthe subtype class
std::vector<NXString> NXOpen::CAM::CAMSession::GetTemplateTypes ( )

Get the names of the available template types.

Returns
the names of the template types
Created in NX4.0.0.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::PathDisplay* NXOpen::CAM::CAMSession::PathDisplay ( )

Returns the NXOpen::CAM::PathDisplay belonging to this cam session
Created in NX10.0.2.


void NXOpen::CAM::CAMSession::SetMcsDisplay ( bool  displayMCS)

Set MCS display
Created in NX8.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
displayMCSwhether the MCS should be displayed
void NXOpen::CAM::CAMSession::SpecifyConfiguration ( const NXString configFile)

Specify the configuration file of the current cam session
Created in NX4.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
configFilethe name of the configuration file
void NXOpen::CAM::CAMSession::SpecifyConfiguration ( const char *  configFile)

Specify the configuration file of the current cam session
Created in NX4.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
configFilethe name of the configuration file
tag_t NXOpen::CAM::CAMSession::Tag ( ) const

Returns the tag of this object.


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