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

Represents a Mechanism Import object used to import a Motion model from a text file. More...

Public Types

enum  NamingRule { NamingRuleNone, NamingRuleAddPrefix, NamingRuleAddSuffix }
 Naming Rule type to modify imported object's name. More...
 

Public Member Functions

void ImportFromSubassembly (NXOpen::Assemblies::Component *compOcc, NXOpen::Part *motionPart, NXOpen::Part *workPart, NXOpen::Motion::MechanismImport::NamingRule namingRule, const NXString &appendixString, bool reportToInfoWindow, bool abortOnFailure)
 Imports a Motion Definition (.sim) Part. More...
 
void ImportFromSubassembly (NXOpen::Assemblies::Component *compOcc, NXOpen::Part *motionPart, NXOpen::Part *workPart, NXOpen::Motion::MechanismImport::NamingRule namingRule, const char *appendixString, bool reportToInfoWindow, bool abortOnFailure)
 Imports a Motion Definition (.sim) Part. More...
 
void ImportMdef (NXOpen::NXObject *workPart, const NXString &fileName, NXOpen::Motion::MechanismImport::NamingRule namingRule, const NXString &addString, bool reportToInfoWindow, bool replaceExistingElements)
 Imports a Motion Definition (.mdef) file. More...
 
void ImportMdef (NXOpen::NXObject *workPart, const char *fileName, NXOpen::Motion::MechanismImport::NamingRule namingRule, const char *addString, bool reportToInfoWindow, bool replaceExistingElements)
 Imports a Motion Definition (.mdef) file. More...
 
void ImportXML (NXOpen::Part *workPart, const NXString &fileName, NXOpen::Motion::MechanismImport::NamingRule namingRule, const NXString &appendixString, bool reportToInfoWindow)
 Imports a Motion Definition (.XML) file. More...
 
void ImportXML (NXOpen::Part *workPart, const char *fileName, NXOpen::Motion::MechanismImport::NamingRule namingRule, const char *appendixString, bool reportToInfoWindow)
 Imports a Motion Definition (.XML) file. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Mechanism Import object used to import a Motion model from a text file.


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

Created in NX12.0.0.

Member Enumeration Documentation

Naming Rule type to modify imported object's name.

Enumerator
NamingRuleNone 

Keeps imported object's name as is.

NamingRuleAddPrefix 

Adds a prefix string to imported object's name.

NamingRuleAddSuffix 

Adds a suffix string to imported object's name.

Member Function Documentation

void NXOpen::Motion::MechanismImport::ImportFromSubassembly ( NXOpen::Assemblies::Component compOcc,
NXOpen::Part motionPart,
NXOpen::Part workPart,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const NXString appendixString,
bool  reportToInfoWindow,
bool  abortOnFailure 
)

Imports a Motion Definition (.sim) Part.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
compOccthe selected component part occ
motionPartthe motion part which the mechanism objects are imported from
workPartthe current work part
namingRuleenum to rule the naming behavior of the imported objects
appendixStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
abortOnFailureFlag to rule whether to abort the process when there is error occurrs
void NXOpen::Motion::MechanismImport::ImportFromSubassembly ( NXOpen::Assemblies::Component compOcc,
NXOpen::Part motionPart,
NXOpen::Part workPart,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const char *  appendixString,
bool  reportToInfoWindow,
bool  abortOnFailure 
)

Imports a Motion Definition (.sim) Part.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
compOccthe selected component part occ
motionPartthe motion part which the mechanism objects are imported from
workPartthe current work part
namingRuleenum to rule the naming behavior of the imported objects
appendixStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
abortOnFailureFlag to rule whether to abort the process when there is error occurrs
void NXOpen::Motion::MechanismImport::ImportMdef ( NXOpen::NXObject workPart,
const NXString fileName,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const NXString addString,
bool  reportToInfoWindow,
bool  replaceExistingElements 
)

Imports a Motion Definition (.mdef) file.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
workPartworkpart
fileNameFull path to the .mdef file
namingRulenamingrule
addStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
replaceExistingElementsFlag to replace elements with same names
void NXOpen::Motion::MechanismImport::ImportMdef ( NXOpen::NXObject workPart,
const char *  fileName,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const char *  addString,
bool  reportToInfoWindow,
bool  replaceExistingElements 
)

Imports a Motion Definition (.mdef) file.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
workPartworkpart
fileNameFull path to the .mdef file
namingRulenamingrule
addStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
replaceExistingElementsFlag to replace elements with same names
void NXOpen::Motion::MechanismImport::ImportXML ( NXOpen::Part workPart,
const NXString fileName,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const NXString appendixString,
bool  reportToInfoWindow 
)

Imports a Motion Definition (.XML) file.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
workPartworkpart
fileNameFull path to the .xml file
namingRulenamingrule
appendixStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
void NXOpen::Motion::MechanismImport::ImportXML ( NXOpen::Part workPart,
const char *  fileName,
NXOpen::Motion::MechanismImport::NamingRule  namingRule,
const char *  appendixString,
bool  reportToInfoWindow 
)

Imports a Motion Definition (.XML) file.


Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
workPartworkpart
fileNameFull path to the .xml file
namingRulenamingrule
appendixStringstring to add when NamingRule is AddPrefix or AddSuffix
reportToInfoWindowFlag to report import status in the information window
tag_t NXOpen::Motion::MechanismImport::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.