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

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

Created in NX9.0.0. More...

Public Types

enum  SimulationAction {
  SimulationActionStart, SimulationActionRestart, SimulationActionPause, SimulationActionResume,
  SimulationActionStop
}
 Represents the action of simulation. More...
 

Public Member Functions

std::vector
< NXOpen::Mechatronics::LogicObject * > 
GetExportableLogicalObjects (NXOpen::Mechatronics::LogicObject *logicalObject)
 Gets exportable logical objects. More...
 
void GetLogicalAttributeNames (std::vector< NXString > &attributeNames)
 Gets defined logical attribute names in configuration file
Created in NX9.0.0. More...
 
std::vector< NXStringGetLogicalAttributeValues (NXOpen::Mechatronics::LogicObject *logicalObject, std::vector< NXString > &attributeNames)
 Gets attribute values of logical object. More...
 
void GetLogicalTypes (std::vector< NXString > &logicalTypeNames, std::vector< NXString > &logicalTypeBitmaps)
 Gets defined logical types in configuration file
Created in NX9.0.0. More...
 
void PerformSimulation (NXOpen::Mechatronics::MechatronicsSession::SimulationAction action)
 Control the Simulation. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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

Created in NX9.0.0.


Member Enumeration Documentation

Represents the action of simulation.

Enumerator
SimulationActionStart 

Start.

SimulationActionRestart 

Restart.

SimulationActionPause 

Pause.

SimulationActionResume 

Resume.

SimulationActionStop 

Stop.

Member Function Documentation

std::vector<NXOpen::Mechatronics::LogicObject *> NXOpen::Mechatronics::MechatronicsSession::GetExportableLogicalObjects ( NXOpen::Mechatronics::LogicObject logicalObject)

Gets exportable logical objects.

Returns
Array of exportable logical objects
Created in NX9.0.0.

License requirements : None
Parameters
logicalObjectLogical object
void NXOpen::Mechatronics::MechatronicsSession::GetLogicalAttributeNames ( std::vector< NXString > &  attributeNames)

Gets defined logical attribute names in configuration file
Created in NX9.0.0.



License requirements : None

Parameters
attributeNamesArray of defined attribute names
std::vector<NXString> NXOpen::Mechatronics::MechatronicsSession::GetLogicalAttributeValues ( NXOpen::Mechatronics::LogicObject logicalObject,
std::vector< NXString > &  attributeNames 
)

Gets attribute values of logical object.

Returns
Array of logical attribute values
Created in NX9.0.0.

License requirements : None
Parameters
logicalObjectLogical object
attributeNamesArray of logical attribute names
void NXOpen::Mechatronics::MechatronicsSession::GetLogicalTypes ( std::vector< NXString > &  logicalTypeNames,
std::vector< NXString > &  logicalTypeBitmaps 
)

Gets defined logical types in configuration file
Created in NX9.0.0.



License requirements : None

Parameters
logicalTypeNamesArray of type names
logicalTypeBitmapsArray of type bitmaps
void NXOpen::Mechatronics::MechatronicsSession::PerformSimulation ( NXOpen::Mechatronics::MechatronicsSession::SimulationAction  action)

Control the Simulation.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
actionaction
tag_t NXOpen::Mechatronics::MechatronicsSession::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.