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

Represents a Motion Environment
To obtain an instance of this class, refer to NXOpen::Motion::MotionSession

Created in NX7.5.0. More...

Public Types

enum  AdoptAssemblyJointStatus { AdoptAssemblyJointStatusUndefined = -1, AdoptAssemblyJointStatusOff, AdoptAssemblyJointStatusOn }
 Represents the on-off status of adopt assembly joint. More...
 
enum  Analysis { AnalysisNoType, AnalysisKinematics, AnalysisDynamics }
 Represents analysis type of current mechanisms. More...
 
enum  JointWizardStatus { JointWizardStatusUndefined = -1, JointWizardStatusOff, JointWizardStatusOn }
 Represents the on-off status of joint wizard. More...
 
enum  Solver {
  SolverNone = -1, SolverRecurdyn, SolverAdams, SolverSimcenter,
  SolverLms = 2, SolverScDesigner
}
 Represents Motion solver of current mechanism. More...
 

Public Member Functions

void CheckCosimLicense (bool checkCosimLicense)
 Checks the co-simulation license
Created in NX7.5.0. More...
 
void CheckFlexbodyLicense (bool checkFlexbodyLicense)
 Checks the flexible body dynamic license
Created in NX7.5.0. More...
 
void CheckMotorLicense (bool checkMotorLicense)
 Checks the motor license
Created in NX7.5.0. More...
 
void EnableCdtire (bool enableCdtire)
 Enable the CD tire
More...
 
void EnableLmsflexbody (bool enableLmsflexbody)
 Enable the LMS flexible body dynamics
More...
 
void EnableMechatronics (bool enableMechatronicsLicense)
 Enable the mechatronics
More...
 
void EnableStdtire (bool enableStdtire)
 Enable the standard tire
More...
 
void EnableSwifttire (bool enableSwifttire)
 Enable the Swift tire
More...
 
void EnableTnotire (bool enableTnotiree)
 Enable the TNO tire
More...
 
NXOpen::Motion::MotionEnvironment::JointWizardStatus GetJointWizardStatus ()
 Gets the on-off status of joint wizard. More...
 
NXOpen::Motion::MotionEnvironment::Solver GetSolver ()
 Gets current Motion solver. More...
 
void SetAnalysisType (NXOpen::Motion::MotionEnvironment::Analysis analysisType)
 Sets the the analysis type
Created in NX7.5.0. More...
 
void SetComponentBasedMechanism (bool componentBasedMech)
 Sets component based mechanism
Created in NX7.5.0. More...
 
void SetJointWizardStatus (NXOpen::Motion::MotionEnvironment::JointWizardStatus setting)
 Sets the on-off status of joint wizard
Created in NX10.0.0. More...
 
void SetSolver (NXOpen::Motion::MotionEnvironment::Solver solver)
 Sets Motion solver
Created in NX10.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Motion Environment
To obtain an instance of this class, refer to NXOpen::Motion::MotionSession

Created in NX7.5.0.


Member Enumeration Documentation

Represents the on-off status of adopt assembly joint.

Enumerator
AdoptAssemblyJointStatusUndefined 

Undefined status.

AdoptAssemblyJointStatusOff 

Adopt Assembly Joint is turned off.

AdoptAssemblyJointStatusOn 

Adopt Assembly Joint is turned on.

Represents analysis type of current mechanisms.

Enumerator
AnalysisNoType 

No analysis type.

AnalysisKinematics 

Kinematics analysis type.

AnalysisDynamics 

Dynamics analysis type.

Represents the on-off status of joint wizard.

Enumerator
JointWizardStatusUndefined 

Undefined status.

JointWizardStatusOff 

Joint Wizard is turned off.

JointWizardStatusOn 

Joint Wizard is turned on.

Represents Motion solver of current mechanism.

Enumerator
SolverNone 

No solver.

SolverRecurdyn 

Motion solver RecurDyn.

SolverAdams 

Motion solver Adams.

SolverSimcenter 

Simcenter Motion solver.

SolverLms 

Simcenter Motion solver (legacy name, deprecated in SC12)

SolverScDesigner 

NX Motion solver.

Member Function Documentation

void NXOpen::Motion::MotionEnvironment::CheckCosimLicense ( bool  checkCosimLicense)

Checks the co-simulation license
Created in NX7.5.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
checkCosimLicenseChecks out or checks in co-simulation license
void NXOpen::Motion::MotionEnvironment::CheckFlexbodyLicense ( bool  checkFlexbodyLicense)

Checks the flexible body dynamic license
Created in NX7.5.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
checkFlexbodyLicenseChecks out or checks in flexible body dynamic license
void NXOpen::Motion::MotionEnvironment::CheckMotorLicense ( bool  checkMotorLicense)

Checks the motor license
Created in NX7.5.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
checkMotorLicenseChecks out or checks in motor license
void NXOpen::Motion::MotionEnvironment::EnableCdtire ( bool  enableCdtire)

Enable the CD tire

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableCdtireenable or disable CD Tire
void NXOpen::Motion::MotionEnvironment::EnableLmsflexbody ( bool  enableLmsflexbody)

Enable the LMS flexible body dynamics

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableLmsflexbodyenable or disable LMS flex body dynamics
void NXOpen::Motion::MotionEnvironment::EnableMechatronics ( bool  enableMechatronicsLicense)

Enable the mechatronics

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableMechatronicsLicenseenable or disable mechatronics
void NXOpen::Motion::MotionEnvironment::EnableStdtire ( bool  enableStdtire)

Enable the standard tire

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableStdtireenable out or disable Standard Tire
void NXOpen::Motion::MotionEnvironment::EnableSwifttire ( bool  enableSwifttire)

Enable the Swift tire

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableSwifttireenable or disable Swift Tire
void NXOpen::Motion::MotionEnvironment::EnableTnotire ( bool  enableTnotiree)

Enable the TNO tire

Deprecated:
Deprecated in NX12.0.0.

Removed without replacement.


Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
enableTnotireeenable or disable TNO Tire
NXOpen::Motion::MotionEnvironment::JointWizardStatus NXOpen::Motion::MotionEnvironment::GetJointWizardStatus ( )

Gets the on-off status of joint wizard.

Returns

Created in NX10.0.0.

License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::MotionEnvironment::Solver NXOpen::Motion::MotionEnvironment::GetSolver ( )

Gets current Motion solver.

Returns

Created in NX10.0.0.

License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::MotionEnvironment::SetAnalysisType ( NXOpen::Motion::MotionEnvironment::Analysis  analysisType)

Sets the the analysis type
Created in NX7.5.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
analysisTypeThe analysis type
void NXOpen::Motion::MotionEnvironment::SetComponentBasedMechanism ( bool  componentBasedMech)

Sets component based mechanism
Created in NX7.5.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
componentBasedMechSets component based mechanism
void NXOpen::Motion::MotionEnvironment::SetJointWizardStatus ( NXOpen::Motion::MotionEnvironment::JointWizardStatus  setting)

Sets the on-off status of joint wizard
Created in NX10.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
settingsetting
void NXOpen::Motion::MotionEnvironment::SetSolver ( NXOpen::Motion::MotionEnvironment::Solver  solver)

Sets Motion solver
Created in NX10.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
solversolver
tag_t NXOpen::Motion::MotionEnvironment::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.