CAMSession Class — NXOpen Python API Reference 12.0.0 documentation

# CAMSession Class

class `NXOpen.CAM.``CAMSession`

  Bases: `object`

  Represents cam session

  To obtain an instance of this class, refer to `NXOpen.Session`

  New in version NX4.0.0.

  “PathDisplay”, “Returns the `NXOpen.CAM.PathDisplay` belonging to this cam session “

# Methods

Method | Description
--- | ---
CreateCamPreferences | Create Cam Preferences builder.
GetMcsDisplay | Get MCS display
GetTemplateSubtypes | Get the names of the available template subypes for the specified template type.
GetTemplateTypes | Get the names of the available template types.
SetMcsDisplay | Set MCS display
SpecifyConfiguration | Specify the configuration file of the current cam session

# Enumerations

CAMSessionObjectSubtype Enumeration | the template subtype class

## PathDisplay

`CAMSession.``PathDisplay`

  Returns the `NXOpen.CAM.PathDisplay` belonging to this cam session

  Signature `PathDisplay`

  New in version NX10.0.2.

  Returns: |
  Return type: | `NXOpen.CAM.PathDisplay`

# Method Detail

## CreateCamPreferences

`CAMSession.``CreateCamPreferences`

  Create Cam Preferences builder.

  Signature `CreateCamPreferences()`

  Returns: | created cam preferences builder
  Return type: | `NXOpen.CAM.Preferences`

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

## GetMcsDisplay

`CAMSession.``GetMcsDisplay`

  Get MCS display

  Signature `GetMcsDisplay()`

  Returns: | whether the MCS should be displayed
  Return type: | bool

  New in version NX8.0.1.

  License requirements: None.

## GetTemplateSubtypes

`CAMSession.``GetTemplateSubtypes`

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

  Only those subtypes have the specified subtype class are returned.

  Signature `GetTemplateSubtypes(typeName, subtypeClass)`

  Parameters:

  - typeName (str) – the name of the template type
  - subtypeClass (`NXOpen.CAM.CAMSessionObjectSubtype`) – the subtype class

  Returns: | the names of available subtypes
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: cam_base (“CAM BASE”)

## GetTemplateTypes

`CAMSession.``GetTemplateTypes`

  Get the names of the available template types.

  Signature `GetTemplateTypes()`

  Returns: | the names of the template types
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: cam_base (“CAM BASE”)

## SetMcsDisplay

`CAMSession.``SetMcsDisplay`

  Set MCS display

  Signature `SetMcsDisplay(displayMCS)`

  Parameters: | displayMCS (bool) – whether the MCS should be displayed

  New in version NX8.0.1.

  License requirements: cam_base (“CAM BASE”)

## SpecifyConfiguration

`CAMSession.``SpecifyConfiguration`

  Specify the configuration file of the current cam session

  Signature `SpecifyConfiguration(configFile)`

  Parameters: | configFile (str) – the name of the configuration file

  New in version NX4.0.0.

  License requirements: cam_base (“CAM BASE”)