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

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

Created in NX5.0.0. More...

Public Member Functions

NXString CloneSimulation (NXOpen::NXObject *masterPart, const NXString &motionSimName)
 Clones the Simulation. More...
 
NXString CloneSimulation (NXOpen::NXObject *masterPart, const char *motionSimName)
 Clones the Simulation. More...
 
NXOpen::NXObjectConstraintsToMotionObject (NXOpen::NXObject *scenarioPart, NXOpen::NXObject *masterPart)
 Converts mating conditions and constraints to links and joints. More...
 
NXString CreateNamingSimulation (NXOpen::NXObject *masterPart, const NXString &inputSimName)
 Creates the Non-master Simulation in NX Manager mode with an input name. More...
 
NXString CreateNamingSimulation (NXOpen::NXObject *masterPart, const char *inputSimName)
 Creates the Non-master Simulation in NX Manager mode with an input name. More...
 
NXOpen::Motion::PhysicsConversionBuilderCreatePhysicsConversionBuilder (NXOpen::NXObject *scenarioPart)
 Creates a NXOpen::Motion::PhysicsConversionBuilder. More...
 
NXString CreateSimulation (NXOpen::NXObject *masterPart)
 Creates the Simulation. More...
 
void DeleteSimulation (NXOpen::NXObject *masterPart, const NXString &motionSimName)
 Deletes the Simulation. More...
 
void DeleteSimulation (NXOpen::NXObject *masterPart, const char *motionSimName)
 Deletes the Simulation. More...
 
void DirectOpenSimulation (const NXString &motionSimName)
 Opens the Simulation directly. More...
 
void DirectOpenSimulation (const char *motionSimName)
 Opens the Simulation directly. More...
 
NXOpen::Motion::MotionEnvironmentEnvironments ()
 Returns the NXOpen::Motion::MotionEnvironment belonging to this part
Created in NX7.5.0. More...
 
void ExportProcessSimulateKinematics ()
 Exports kinematics for Process Simulate
Created in NX8.5.0. More...
 
NXOpen::NXObjectFixLinkToGround (NXOpen::NXObject *link)
 Fixes the link to ground. More...
 
NXString GetFullName (NXOpen::NXObject *masterPart, const NXString &scenarioName)
 Gets the full name for a scenario name, which is located in motion subfolder of master part. More...
 
NXString GetFullName (NXOpen::NXObject *masterPart, const char *scenarioName)
 Gets the full name for a scenario name, which is located in motion subfolder of master part. More...
 
std::vector< NXOpen::NXObject * > GetFunctionReferencedMotionObjects (NXOpen::NXObject *scenarioPart, NXOpen::Motion::MotionFunction *funcObject)
 Gets function referenced motion objects. More...
 
std::vector< NXOpen::NXObject * > GetFunctionReferencingMotionObjects (NXOpen::NXObject *scenarioPart, NXOpen::Motion::MotionFunction *funcObject)
 Gets function referencing motion objects. More...
 
std::vector
< NXOpen::Motion::MotionFunction * > 
GetReferencedFunctions (NXOpen::NXObject *scenarioPart, NXOpen::NXObject *originObject)
 Gets the referenced functions. More...
 
std::vector< NXOpen::NXObject * > GetReferencedMotionObjects (NXOpen::NXObject *scenarioPart, NXOpen::NXObject *originObject)
 Gets the referenced motion objects. More...
 
std::vector
< NXOpen::Motion::MotionFunction * > 
GetReferencingFunctions (NXOpen::NXObject *scenarioPart, NXOpen::NXObject *originObject)
 Gets the referencing functions. More...
 
std::vector< NXOpen::NXObject * > GetReferencingMotionObjects (NXOpen::NXObject *scenarioPart, NXOpen::NXObject *originObject)
 Gets the referencing motion objects. More...
 
std::vector< NXStringGetScenarioNames (NXOpen::NXObject *masterPart)
 Gets all scenario names from motion subfolder of master part. More...
 
void InitializeMechanisms ()
 Initializes the mech
More...
 
void InitializeSimulation (NXOpen::Part *simulationPart)
 Initializes the motion simulation context for the loaded motion part
Created in NX12.0.0. More...
 
NXOpen::Motion::MechanismExportMechanismExport ()
 Returns the NXOpen::Motion::MechanismExport object belonging to this part
Created in NX12.0.0. More...
 
NXOpen::Motion::MechanismImportMechanismImport ()
 Returns the NXOpen::Motion::MechanismImport object belonging to this part
Created in NX12.0.0. More...
 
NXOpen::Motion::MotionMethodsMotionMethods ()
 Returns the NXOpen::Motion::MotionMethods belonging to this part
Created in NX8.0.0. More...
 
NXOpen::Motion::PostProcessPostProcess ()
 Returns the NXOpen::Motion::PostProcess belonging to this part
Created in NX7.5.0. More...
 
void ReparentSimulation (const NXString &motionSimFullName, const NXString &destinationDirectory)
 Reparents the Simulation. More...
 
void ReparentSimulation (const char *motionSimFullName, const char *destinationDirectory)
 Reparents the Simulation. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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

Created in NX5.0.0.


Member Function Documentation

NXString NXOpen::Motion::MotionSession::CloneSimulation ( NXOpen::NXObject masterPart,
const NXString motionSimName 
)

Clones the Simulation.

Returns
new motion simulation part name
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master part
motionSimNamemotion simulation part which ready to be cloned
NXString NXOpen::Motion::MotionSession::CloneSimulation ( NXOpen::NXObject masterPart,
const char *  motionSimName 
)

Clones the Simulation.

Returns
new motion simulation part name
Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master part
motionSimNamemotion simulation part which ready to be cloned
NXOpen::NXObject* NXOpen::Motion::MotionSession::ConstraintsToMotionObject ( NXOpen::NXObject scenarioPart,
NXOpen::NXObject masterPart 
)

Converts mating conditions and constraints to links and joints.

Returns
the link which will be fixed to ground
Created in NX6.0.1.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartthe scenario part object
masterPartthe master part object
NXString NXOpen::Motion::MotionSession::CreateNamingSimulation ( NXOpen::NXObject masterPart,
const NXString inputSimName 
)

Creates the Non-master Simulation in NX Manager mode with an input name.

Returns
the created motion simulation part name
Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master_part
inputSimNamethe input simulation name
NXString NXOpen::Motion::MotionSession::CreateNamingSimulation ( NXOpen::NXObject masterPart,
const char *  inputSimName 
)

Creates the Non-master Simulation in NX Manager mode with an input name.

Returns
the created motion simulation part name
Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master_part
inputSimNamethe input simulation name
NXOpen::Motion::PhysicsConversionBuilder* NXOpen::Motion::MotionSession::CreatePhysicsConversionBuilder ( NXOpen::NXObject scenarioPart)

Creates a NXOpen::Motion::PhysicsConversionBuilder.

Returns

Created in NX8.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
NXString NXOpen::Motion::MotionSession::CreateSimulation ( NXOpen::NXObject masterPart)

Creates the Simulation.

Returns
created motion simulation part name
Deprecated:
Deprecated in NX12.0.0. Use NXOpen::FileNew and NXOpen::Motion::MotionSession::InitializeSimulation


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master_part
void NXOpen::Motion::MotionSession::DeleteSimulation ( NXOpen::NXObject masterPart,
const NXString motionSimName 
)

Deletes the Simulation.


Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master_part
motionSimNamemotion simulation part which ready to be deleted
void NXOpen::Motion::MotionSession::DeleteSimulation ( NXOpen::NXObject masterPart,
const char *  motionSimName 
)

Deletes the Simulation.


Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master_part
motionSimNamemotion simulation part which ready to be deleted
void NXOpen::Motion::MotionSession::DirectOpenSimulation ( const NXString motionSimName)

Opens the Simulation directly.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::PartCollection::OpenDisplay and NXOpen::Motion::MotionSession::InitializeSimulation


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
motionSimNamemotion simulation part name
void NXOpen::Motion::MotionSession::DirectOpenSimulation ( const char *  motionSimName)

Opens the Simulation directly.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::PartCollection::OpenDisplay and NXOpen::Motion::MotionSession::InitializeSimulation


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
motionSimNamemotion simulation part name
NXOpen::Motion::MotionEnvironment* NXOpen::Motion::MotionSession::Environments ( )

Returns the NXOpen::Motion::MotionEnvironment belonging to this part
Created in NX7.5.0.


void NXOpen::Motion::MotionSession::ExportProcessSimulateKinematics ( )

Exports kinematics for Process Simulate
Created in NX8.5.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::NXObject* NXOpen::Motion::MotionSession::FixLinkToGround ( NXOpen::NXObject link)

Fixes the link to ground.

Returns
the joint object created
Created in NX6.0.1.

License requirements : mechanisms ("MECHANISMS")
Parameters
linkthe link object
NXString NXOpen::Motion::MotionSession::GetFullName ( NXOpen::NXObject masterPart,
const NXString scenarioName 
)

Gets the full name for a scenario name, which is located in motion subfolder of master part.

Returns
full path to the file
Created in NX7.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master part object
scenarioNamescenario name to check (with or without extension)
NXString NXOpen::Motion::MotionSession::GetFullName ( NXOpen::NXObject masterPart,
const char *  scenarioName 
)

Gets the full name for a scenario name, which is located in motion subfolder of master part.

Returns
full path to the file
Created in NX7.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master part object
scenarioNamescenario name to check (with or without extension)
std::vector<NXOpen::NXObject *> NXOpen::Motion::MotionSession::GetFunctionReferencedMotionObjects ( NXOpen::NXObject scenarioPart,
NXOpen::Motion::MotionFunction funcObject 
)

Gets function referenced motion objects.

Returns
The referenced motion objects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
funcObjectfuncobject
std::vector<NXOpen::NXObject *> NXOpen::Motion::MotionSession::GetFunctionReferencingMotionObjects ( NXOpen::NXObject scenarioPart,
NXOpen::Motion::MotionFunction funcObject 
)

Gets function referencing motion objects.

Returns
The referencing motion objects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
funcObjectfuncobject
std::vector<NXOpen::Motion::MotionFunction *> NXOpen::Motion::MotionSession::GetReferencedFunctions ( NXOpen::NXObject scenarioPart,
NXOpen::NXObject originObject 
)

Gets the referenced functions.

Returns
The referenced functions
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
originObjectNon-function motion object.
std::vector<NXOpen::NXObject *> NXOpen::Motion::MotionSession::GetReferencedMotionObjects ( NXOpen::NXObject scenarioPart,
NXOpen::NXObject originObject 
)

Gets the referenced motion objects.

Returns
The referenced motion objects
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
originObjectNon-function motion object. For function, please use Motion::MotionSession::GetReferencedMotionObjects .
std::vector<NXOpen::Motion::MotionFunction *> NXOpen::Motion::MotionSession::GetReferencingFunctions ( NXOpen::NXObject scenarioPart,
NXOpen::NXObject originObject 
)

Gets the referencing functions.

Returns
The referencing functions
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
originObjectNon-function motion object.
std::vector<NXOpen::NXObject *> NXOpen::Motion::MotionSession::GetReferencingMotionObjects ( NXOpen::NXObject scenarioPart,
NXOpen::NXObject originObject 
)

Gets the referencing motion objects.

Returns
The referencing motion objects.
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
scenarioPartscenario part
originObjectNon-function motion object. For function, please use Motion::MotionSession::GetReferencingMotionObjects .
std::vector<NXString> NXOpen::Motion::MotionSession::GetScenarioNames ( NXOpen::NXObject masterPart)

Gets all scenario names from motion subfolder of master part.

Returns
scenario names
Created in NX7.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
masterPartthe master part object
void NXOpen::Motion::MotionSession::InitializeMechanisms ( )

Initializes the mech

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Motion::MotionSession::InitializeSimulation


Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::MotionSession::InitializeSimulation ( NXOpen::Part simulationPart)

Initializes the motion simulation context for the loaded motion part
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
simulationPartthe loaded motion simulation part
NXOpen::Motion::MechanismExport* NXOpen::Motion::MotionSession::MechanismExport ( )

Returns the NXOpen::Motion::MechanismExport object belonging to this part
Created in NX12.0.0.


NXOpen::Motion::MechanismImport* NXOpen::Motion::MotionSession::MechanismImport ( )

Returns the NXOpen::Motion::MechanismImport object belonging to this part
Created in NX12.0.0.


NXOpen::Motion::MotionMethods* NXOpen::Motion::MotionSession::MotionMethods ( )

Returns the NXOpen::Motion::MotionMethods belonging to this part
Created in NX8.0.0.


NXOpen::Motion::PostProcess* NXOpen::Motion::MotionSession::PostProcess ( )

Returns the NXOpen::Motion::PostProcess belonging to this part
Created in NX7.5.0.


void NXOpen::Motion::MotionSession::ReparentSimulation ( const NXString motionSimFullName,
const NXString destinationDirectory 
)

Reparents the Simulation.


Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
motionSimFullNamemotion simulation full name
destinationDirectorydestination directory
void NXOpen::Motion::MotionSession::ReparentSimulation ( const char *  motionSimFullName,
const char *  destinationDirectory 
)

Reparents the Simulation.


Deprecated:
Deprecated in NX12.0.0. Removed without replacement.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
motionSimFullNamemotion simulation full name
destinationDirectorydestination directory
tag_t NXOpen::Motion::MotionSession::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.