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

Represents Motion.Simulation
To obtain an instance of this class, refer to NXOpen::Session

Created in NX5.0.0. More...

Public Member Functions

void AddMaster (NXOpen::Part *motionPart, NXOpen::NXObject *masterPart)
 Creates a new NXOpen::Assemblies::Component in this motion simulation assembly as master part
Created in NX12.0.0. More...
 
void AddSuppressedObjectForAllSolutions (NXOpen::Part *motionPart, NXOpen::NXObject *obj)
 Deactivates a motion object for all solutions
Created in NX12.0.0. More...
 
int CalculateGrueblerCount (NXOpen::NXObject *motionPart)
 Calculate the gruebler count of given motion part. More...
 
NXOpen::Motion::AddSubmechanismBuilderCreateAddSubmechanismBuilder (NXOpen::NXObject *part)
 Returns NXOpen::Motion::AddSubmechanismBuilder object. More...
 
void ExportRecurdynSdk (const NXString &fullFileName)
 Export Recurdyn sdk data, need an active solution in simulation
Created in NX7.0.0. More...
 
void ExportRecurdynSdk (const char *fullFileName)
 Export Recurdyn sdk data, need an active solution in simulation
Created in NX7.0.0. More...
 
NXOpen::PartGetMasterCadPart (NXOpen::Part *motionPart)
 Gets the loaded master part in this motion simulation assembly. More...
 
void LoadSimulation (NXOpen::NXObject *masterPart, const NXString &motionSimName)
 Load the simulation
More...
 
void LoadSimulation (NXOpen::NXObject *masterPart, const char *motionSimName)
 Load the simulation
More...
 
void ReadDeactivatedStates (NXOpen::NXObject *sumbmechanism, NXOpen::Motion::MotionSolution *solution)
 Copies the deactivated states of motion objects occurrences belonging to a given submechanism from a given solution to the motion assembly. More...
 
void RemoveMaster (NXOpen::Part *motionPart, bool deleteMotionObjects)
 Removes existing master part in this motion simulation assembly
Created in NX12.0.0. More...
 
void RemoveSuppressedObjectForAllSolutions (NXOpen::Part *motionPart, NXOpen::NXObject *obj)
 Activates a motion object for all solutions
Created in NX12.0.0. More...
 
void RenameSimulation (NXOpen::NXObject *masterPart, const NXString &oldMotionSimName, const NXString &newMotionSimName)
 Rename the simulation
More...
 
void RenameSimulation (NXOpen::NXObject *masterPart, const char *oldMotionSimName, const char *newMotionSimName)
 Rename the simulation
More...
 
void RenameSubmechanism (NXOpen::NXObject *submechanism, const NXString &name)
 Sets the custom name of the Submechanism object. More...
 
void RenameSubmechanism (NXOpen::NXObject *submechanism, const char *name)
 Sets the custom name of the Submechanism object. More...
 
void SaveSimulation (NXOpen::NXObject *masterPart, const NXString &motionSimName)
 Save the simulation through input part name
More...
 
void SaveSimulation (NXOpen::NXObject *masterPart, const char *motionSimName)
 Save the simulation through input part name
More...
 
void SaveSimulation (NXOpen::NXObject *masterPart, NXOpen::NXObject *motionSimPart)
 Save the simulation through input part object
More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UnloadSimulation (NXOpen::NXObject *masterPart, const NXString &motionSimName)
 Unload the simulation through input part name
More...
 
void UnloadSimulation (NXOpen::NXObject *masterPart, const char *motionSimName)
 Unload the simulation through input part name
More...
 
void UnloadSimulation (NXOpen::NXObject *masterPart, NXOpen::NXObject *motionSimPart)
 Unload the simulation through input part object
More...
 

Detailed Description

Represents Motion.Simulation
To obtain an instance of this class, refer to NXOpen::Session

Created in NX5.0.0.


Member Function Documentation

void NXOpen::Motion::MotionSimulation::AddMaster ( NXOpen::Part motionPart,
NXOpen::NXObject masterPart 
)

Creates a new NXOpen::Assemblies::Component in this motion simulation assembly as master part
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
motionPartthe motion part to add master part into it
masterPartthe master part to be added, it can be a part occurrence tag or part tag
void NXOpen::Motion::MotionSimulation::AddSuppressedObjectForAllSolutions ( NXOpen::Part motionPart,
NXOpen::NXObject obj 
)

Deactivates a motion object for all solutions
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
motionPartmotionpart
objobj
int NXOpen::Motion::MotionSimulation::CalculateGrueblerCount ( NXOpen::NXObject motionPart)

Calculate the gruebler count of given motion part.

Returns
gruebler count
Created in NX7.5.0.

License requirements : None
Parameters
motionPartmotion part object
NXOpen::Motion::AddSubmechanismBuilder* NXOpen::Motion::MotionSimulation::CreateAddSubmechanismBuilder ( NXOpen::NXObject part)

Returns NXOpen::Motion::AddSubmechanismBuilder object.

Returns
NXOpen::Motion::AddSubmechanismBuilder object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
partthe part object
void NXOpen::Motion::MotionSimulation::ExportRecurdynSdk ( const NXString fullFileName)

Export Recurdyn sdk data, need an active solution in simulation
Created in NX7.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
fullFileNamefull name with directory and extension
void NXOpen::Motion::MotionSimulation::ExportRecurdynSdk ( const char *  fullFileName)

Export Recurdyn sdk data, need an active solution in simulation
Created in NX7.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
fullFileNamefull name with directory and extension
NXOpen::Part* NXOpen::Motion::MotionSimulation::GetMasterCadPart ( NXOpen::Part motionPart)

Gets the loaded master part in this motion simulation assembly.

Returns
the loaded master part
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
motionPartthe motion part to remove master part from it
void NXOpen::Motion::MotionSimulation::LoadSimulation ( NXOpen::NXObject masterPart,
const NXString motionSimName 
)

Load the simulation

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
masterPartthe master part object
motionSimNamethe motion simulation name to load
void NXOpen::Motion::MotionSimulation::LoadSimulation ( NXOpen::NXObject masterPart,
const char *  motionSimName 
)

Load the simulation

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
masterPartthe master part object
motionSimNamethe motion simulation name to load
void NXOpen::Motion::MotionSimulation::ReadDeactivatedStates ( NXOpen::NXObject sumbmechanism,
NXOpen::Motion::MotionSolution solution 
)

Copies the deactivated states of motion objects occurrences belonging to a given submechanism from a given solution to the motion assembly.

The motion objects deactivated from the given solution will become "Deactivated for All" in the motion assembly. If submechanism tag is NULL then will copy the deactivated states from the selected solution to the active one.
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
sumbmechanismsubmechanism child of current root part
solutionthe solution, from the submechanism part, from which the deactivated states are read
void NXOpen::Motion::MotionSimulation::RemoveMaster ( NXOpen::Part motionPart,
bool  deleteMotionObjects 
)

Removes existing master part in this motion simulation assembly
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
motionPartthe motion part to remove master part from it
deleteMotionObjectsthe tag whether to keep or delete motion objects referencing master part
void NXOpen::Motion::MotionSimulation::RemoveSuppressedObjectForAllSolutions ( NXOpen::Part motionPart,
NXOpen::NXObject obj 
)

Activates a motion object for all solutions
Created in NX12.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
motionPartmotionpart
objobj
void NXOpen::Motion::MotionSimulation::RenameSimulation ( NXOpen::NXObject masterPart,
const NXString oldMotionSimName,
const NXString newMotionSimName 
)

Rename the simulation

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::SaveAs


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
oldMotionSimNamethe motion simulation part name which ready to be renamed
newMotionSimNamethe new motion simulation part name
void NXOpen::Motion::MotionSimulation::RenameSimulation ( NXOpen::NXObject masterPart,
const char *  oldMotionSimName,
const char *  newMotionSimName 
)

Rename the simulation

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::SaveAs


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
oldMotionSimNamethe motion simulation part name which ready to be renamed
newMotionSimNamethe new motion simulation part name
void NXOpen::Motion::MotionSimulation::RenameSubmechanism ( NXOpen::NXObject submechanism,
const NXString name 
)

Sets the custom name of the Submechanism object.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
submechanismsubmechanism
namename
void NXOpen::Motion::MotionSimulation::RenameSubmechanism ( NXOpen::NXObject submechanism,
const char *  name 
)

Sets the custom name of the Submechanism object.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
submechanismsubmechanism
namename
void NXOpen::Motion::MotionSimulation::SaveSimulation ( NXOpen::NXObject masterPart,
const NXString motionSimName 
)

Save the simulation through input part name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Save


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimNamethe motion simulation part name which ready to be saved
void NXOpen::Motion::MotionSimulation::SaveSimulation ( NXOpen::NXObject masterPart,
const char *  motionSimName 
)

Save the simulation through input part name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Save


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimNamethe motion simulation part name which ready to be saved
void NXOpen::Motion::MotionSimulation::SaveSimulation ( NXOpen::NXObject masterPart,
NXOpen::NXObject motionSimPart 
)

Save the simulation through input part object

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Save


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimPartthe motion simulation part which ready to be saved
tag_t NXOpen::Motion::MotionSimulation::Tag ( ) const

Returns the tag of this object.

void NXOpen::Motion::MotionSimulation::UnloadSimulation ( NXOpen::NXObject masterPart,
const NXString motionSimName 
)

Unload the simulation through input part name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Close


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimNamethe motion simulation name to unload
void NXOpen::Motion::MotionSimulation::UnloadSimulation ( NXOpen::NXObject masterPart,
const char *  motionSimName 
)

Unload the simulation through input part name

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Close


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimNamethe motion simulation name to unload
void NXOpen::Motion::MotionSimulation::UnloadSimulation ( NXOpen::NXObject masterPart,
NXOpen::NXObject motionSimPart 
)

Unload the simulation through input part object

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::BasePart::Close


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
masterPartthe master part object
motionSimPartthe motion simulation to unload

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.