NXOpen::CAM::CAMSession Class Reference

Represents cam session
To obtain an instance of this class, refer to 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::Preferences *	CreateCamPreferences ()
	Create Cam Preferences builder.
bool	GetMcsDisplay ()
	Get MCS display.
std::vector< NXString >	GetTemplateSubtypes (const NXString &typeName, NXOpen::CAM::CAMSession::ObjectSubtype subtypeClass)
	Get the names of the available template subypes for the specified template type.
std::vector< NXString >	GetTemplateSubtypes (const char *typeName, NXOpen::CAM::CAMSession::ObjectSubtype subtypeClass)
	Get the names of the available template subypes for the specified template type.
std::vector< NXString >	GetTemplateTypes ()
	Get the names of the available template types.
void	SetMcsDisplay (bool displayMCS)
	Set MCS display Created in NX8.0.1.
void	SpecifyConfiguration (const NXString &configFile)
	Specify the configuration file of the current cam session Created in NX4.0.0.
void	SpecifyConfiguration (const char *configFile)
	Specify the configuration file of the current cam session Created in NX4.0.0.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::CAMSession::ObjectSubtype

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

typeName	the name of the template type NOTE: The full Unicode character set is not supported for this parameter.
subtypeClass	the 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

typeName	the name of the template type NOTE: The full Unicode character set is not supported for this parameter.
subtypeClass	the 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")

void NXOpen::CAM::CAMSession::SetMcsDisplay

(

bool

displayMCS

)

Set MCS display
Created in NX8.0.1.

License requirements : cam_base ("CAM BASE")

Parameters

displayMCS

whether 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

configFile

the name of the configuration file NOTE: The full Unicode character set is not supported for this parameter.

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

configFile

the name of the configuration file NOTE: The full Unicode character set is not supported for this parameter.

tag_t NXOpen::CAM::CAMSession::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• CAM_CAMSession.hxx