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

Contains the collection objects for creating and iterating over Mechatronics Designer System Navigator objects. More...

Public Member Functions

void AddExistingFunction (NXOpen::Mechatronics::SystemObject *object, const NXString &itemMFKID, const NXString &instanceName)
 Adds existing function as children of specified object. More...
 
void AddExistingFunction (NXOpen::Mechatronics::SystemObject *object, const char *itemMFKID, const char *instanceName)
 Adds existing function as children of specified object. More...
 
void AddExistingLogical (NXOpen::Mechatronics::SystemObject *object, const NXString &itemMFKID, const NXString &instanceName)
 Adds existing logical as children of specified object. More...
 
void AddExistingLogical (NXOpen::Mechatronics::SystemObject *object, const char *itemMFKID, const char *instanceName)
 Adds existing logical as children of specified object. More...
 
void AddExistingRequirement (NXOpen::Mechatronics::SystemObject *object, const NXString &itemMFKID, const NXString &instanceName)
 Adds existing requirement as children of specified object. More...
 
void AddExistingRequirement (NXOpen::Mechatronics::SystemObject *object, const char *itemMFKID, const char *instanceName)
 Adds existing requirement as children of specified object. More...
 
void CopySystemObject (const std::vector< NXOpen::Mechatronics::SystemObject * > &objects)
 Copies the system engeering objects to the clipboard. More...
 
NXOpen::Mechatronics::DependencyCreatorBuilderCreateDependencyCreatorBuilder ()
 Creates a NXOpen::Mechatronics::DependencyCreatorBuilder object. More...
 
NXOpen::Mechatronics::SystemRootCreateSystemRoot (NXOpen::Mechatronics::SystemRoot::Type rootType)
 Creates a system root object in specified part. More...
 
void CutSystemObject (const std::vector< NXOpen::Mechatronics::SystemObject * > &objects)
 Cuts the system engeering objects. More...
 
NXOpen::Mechatronics::ElectricalPartCollectionElectricalPartCollection ()
 Returns the ElectricalPartCollection instance belonging to this part
Created in NX9.0.0. More...
 
void ExportModel (const NXString &path, bool bFunction, bool bLogical)
 Exports function and(or) logical model to XML file. More...
 
void ExportModel (const char *path, bool bFunction, bool bLogical)
 Exports function and(or) logical model to XML file. More...
 
void ExportModel (const NXString &path, bool requirement, bool function, bool logic)
 Exports data model to XML file. More...
 
void ExportModel (const char *path, bool requirement, bool function, bool logic)
 Exports data model to XML file. More...
 
NXOpen::Mechatronics::FunctionObjectCollectionFunctionObjectCollection ()
 Returns the FunctionObjectCollection instance belonging to this part
Created in NX7.5.0. More...
 
NXOpen::Mechatronics::SystemRootGetSystemRoot (NXOpen::Mechatronics::SystemRoot::Type rootType)
 Gets the system root object in the specified part. More...
 
void ImportModel (const NXString &path, bool bFunction, bool bLogical)
 Imports function and(or) logical model via XML file. More...
 
void ImportModel (const char *path, bool bFunction, bool bLogical)
 Imports function and(or) logical model via XML file. More...
 
void ImportModel (const NXString &path, bool overrideModel, bool requirement, bool function, bool logic)
 Imports data model from XML file. More...
 
void ImportModel (const char *path, bool overrideModel, bool requirement, bool function, bool logic)
 Imports data model from XML file. More...
 
NXString LoadAsSaved ()
 Loads the data models as saved in last time. More...
 
void LogEntityToDelete (NXOpen::NXObject *object)
 Log entity to delete. More...
 
NXOpen::Mechatronics::LogicObjectCollectionLogicObjectCollection ()
 Returns the LogicObjectCollection instance belonging to this part
Created in NX8.5.0. More...
 
void OpenFunctionModel (const NXString &itemMFKID, const NXString &variantRule)
 Opens the specified function model. More...
 
void OpenFunctionModel (const char *itemMFKID, const char *variantRule)
 Opens the specified function model. More...
 
void OpenLogicalModel (const NXString &itemMFKID, const NXString &variantRule)
 Opens the specified logical model. More...
 
void OpenLogicalModel (const char *itemMFKID, const char *variantRule)
 Opens the specified logical model. More...
 
void OpenRequirementModel (const NXString &itemMFKID, const NXString &variantRule)
 Opens the specified requirement model. More...
 
void OpenRequirementModel (const char *itemMFKID, const char *variantRule)
 Opens the specified requirement model. More...
 
void PasteSystemObject (NXOpen::Mechatronics::SystemObject *parent)
 Pastes the system engeering objects from the clipboard. More...
 
void PasteTraceLink (NXOpen::Mechatronics::SystemObject *object)
 Adds existing requirement as tracelink of specified object. More...
 
void RefreshFromTeamcenter (bool bFunction, bool bLogical)
 Refreshes function and(or) logical model from teamcenter. More...
 
void RefreshFromTeamcenter (bool requirement, bool function, bool logic)
 Refreshes data model in system navigator from teamcenter. More...
 
NXOpen::Mechatronics::RequirementCollectionRequirementCollection ()
 Returns the RequirementCollection instance belonging to this part
Created in NX8.5.0. More...
 
void SaveToTeamcenter ()
 Saves the data model to teamcenter. More...
 
void SaveToTeamcenter (bool requirement, bool function, bool logic)
 Saves the data model to teamcenter. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Contains the collection objects for creating and iterating over Mechatronics Designer System Navigator objects.


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

Created in NX7.5.1.

Member Function Documentation

void NXOpen::Mechatronics::MechatronicsManager::AddExistingFunction ( NXOpen::Mechatronics::SystemObject object,
const NXString itemMFKID,
const NXString instanceName 
)

Adds existing function as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child function item
instanceNameThe instance name of child function item
void NXOpen::Mechatronics::MechatronicsManager::AddExistingFunction ( NXOpen::Mechatronics::SystemObject object,
const char *  itemMFKID,
const char *  instanceName 
)

Adds existing function as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child function item
instanceNameThe instance name of child function item
void NXOpen::Mechatronics::MechatronicsManager::AddExistingLogical ( NXOpen::Mechatronics::SystemObject object,
const NXString itemMFKID,
const NXString instanceName 
)

Adds existing logical as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child logical item
instanceNameThe instance name of child logical item
void NXOpen::Mechatronics::MechatronicsManager::AddExistingLogical ( NXOpen::Mechatronics::SystemObject object,
const char *  itemMFKID,
const char *  instanceName 
)

Adds existing logical as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child logical item
instanceNameThe instance name of child logical item
void NXOpen::Mechatronics::MechatronicsManager::AddExistingRequirement ( NXOpen::Mechatronics::SystemObject object,
const NXString itemMFKID,
const NXString instanceName 
)

Adds existing requirement as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child requirement item
instanceNameThe instance name of child requirement item
void NXOpen::Mechatronics::MechatronicsManager::AddExistingRequirement ( NXOpen::Mechatronics::SystemObject object,
const char *  itemMFKID,
const char *  instanceName 
)

Adds existing requirement as children of specified object.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectThe parent object
itemMFKIDThe Item MFK ID of child requirement item
instanceNameThe instance name of child requirement item
void NXOpen::Mechatronics::MechatronicsManager::CopySystemObject ( const std::vector< NXOpen::Mechatronics::SystemObject * > &  objects)

Copies the system engeering objects to the clipboard.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectsThe objects to be copied
NXOpen::Mechatronics::DependencyCreatorBuilder* NXOpen::Mechatronics::MechatronicsManager::CreateDependencyCreatorBuilder ( )

Creates a NXOpen::Mechatronics::DependencyCreatorBuilder object.

Returns
DependencyCreator Builder
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXOpen::Mechatronics::SystemRoot* NXOpen::Mechatronics::MechatronicsManager::CreateSystemRoot ( NXOpen::Mechatronics::SystemRoot::Type  rootType)

Creates a system root object in specified part.

Returns
Return the system root
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
Parameters
rootTypeThe type of system root
void NXOpen::Mechatronics::MechatronicsManager::CutSystemObject ( const std::vector< NXOpen::Mechatronics::SystemObject * > &  objects)

Cuts the system engeering objects.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectsThe objects to be cutted
NXOpen::Mechatronics::ElectricalPartCollection* NXOpen::Mechatronics::MechatronicsManager::ElectricalPartCollection ( )

Returns the ElectricalPartCollection instance belonging to this part
Created in NX9.0.0.


void NXOpen::Mechatronics::MechatronicsManager::ExportModel ( const NXString path,
bool  bFunction,
bool  bLogical 
)

Exports function and(or) logical model to XML file.


Deprecated:
Deprecated in NX9.0.0. Please use another method with the same name instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathpath
bFunctionbfunction
bLogicalblogical
void NXOpen::Mechatronics::MechatronicsManager::ExportModel ( const char *  path,
bool  bFunction,
bool  bLogical 
)

Exports function and(or) logical model to XML file.


Deprecated:
Deprecated in NX9.0.0. Please use another method with the same name instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathpath
bFunctionbfunction
bLogicalblogical
void NXOpen::Mechatronics::MechatronicsManager::ExportModel ( const NXString path,
bool  requirement,
bool  function,
bool  logic 
)

Exports data model to XML file.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathThe path of XML file
requirementExport the Requirement Model?
functionExport the Function Model?
logicExport the Logical Model?
void NXOpen::Mechatronics::MechatronicsManager::ExportModel ( const char *  path,
bool  requirement,
bool  function,
bool  logic 
)

Exports data model to XML file.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathThe path of XML file
requirementExport the Requirement Model?
functionExport the Function Model?
logicExport the Logical Model?
NXOpen::Mechatronics::FunctionObjectCollection* NXOpen::Mechatronics::MechatronicsManager::FunctionObjectCollection ( )

Returns the FunctionObjectCollection instance belonging to this part
Created in NX7.5.0.


NXOpen::Mechatronics::SystemRoot* NXOpen::Mechatronics::MechatronicsManager::GetSystemRoot ( NXOpen::Mechatronics::SystemRoot::Type  rootType)

Gets the system root object in the specified part.

Returns
Return the system root
Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
Parameters
rootTypeThe type of system root
void NXOpen::Mechatronics::MechatronicsManager::ImportModel ( const NXString path,
bool  bFunction,
bool  bLogical 
)

Imports function and(or) logical model via XML file.


Deprecated:
Deprecated in NX9.0.0. Please use another method with the same name instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathpath
bFunctionbfunction
bLogicalblogical
void NXOpen::Mechatronics::MechatronicsManager::ImportModel ( const char *  path,
bool  bFunction,
bool  bLogical 
)

Imports function and(or) logical model via XML file.


Deprecated:
Deprecated in NX9.0.0. Please use another method with the same name instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathpath
bFunctionbfunction
bLogicalblogical
void NXOpen::Mechatronics::MechatronicsManager::ImportModel ( const NXString path,
bool  overrideModel,
bool  requirement,
bool  function,
bool  logic 
)

Imports data model from XML file.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathThe path of XML file
overrideModelOverride the existing model?
requirementImport the Requirement Model?
functionImport the Function Model?
logicImport the Logical Model?
void NXOpen::Mechatronics::MechatronicsManager::ImportModel ( const char *  path,
bool  overrideModel,
bool  requirement,
bool  function,
bool  logic 
)

Imports data model from XML file.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathThe path of XML file
overrideModelOverride the existing model?
requirementImport the Requirement Model?
functionImport the Function Model?
logicImport the Logical Model?
NXString NXOpen::Mechatronics::MechatronicsManager::LoadAsSaved ( )

Loads the data models as saved in last time.

Returns
Return information if some item revisions are deleted
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
void NXOpen::Mechatronics::MechatronicsManager::LogEntityToDelete ( NXOpen::NXObject object)

Log entity to delete.

Use this method to log entity to delete if the root part is not work part.
Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectobject
NXOpen::Mechatronics::LogicObjectCollection* NXOpen::Mechatronics::MechatronicsManager::LogicObjectCollection ( )

Returns the LogicObjectCollection instance belonging to this part
Created in NX8.5.0.


void NXOpen::Mechatronics::MechatronicsManager::OpenFunctionModel ( const NXString itemMFKID,
const NXString variantRule 
)

Opens the specified function model.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root function
variantRuleThe variant rule of root function
void NXOpen::Mechatronics::MechatronicsManager::OpenFunctionModel ( const char *  itemMFKID,
const char *  variantRule 
)

Opens the specified function model.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root function
variantRuleThe variant rule of root function
void NXOpen::Mechatronics::MechatronicsManager::OpenLogicalModel ( const NXString itemMFKID,
const NXString variantRule 
)

Opens the specified logical model.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root logical
variantRuleThe variant rule of root logical
void NXOpen::Mechatronics::MechatronicsManager::OpenLogicalModel ( const char *  itemMFKID,
const char *  variantRule 
)

Opens the specified logical model.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root logical
variantRuleThe variant rule of root logical
void NXOpen::Mechatronics::MechatronicsManager::OpenRequirementModel ( const NXString itemMFKID,
const NXString variantRule 
)

Opens the specified requirement model.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root requirement
variantRuleThe variant rule of root requirement
void NXOpen::Mechatronics::MechatronicsManager::OpenRequirementModel ( const char *  itemMFKID,
const char *  variantRule 
)

Opens the specified requirement model.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
itemMFKIDThe Item MFK ID of root requirement
variantRuleThe variant rule of root requirement
void NXOpen::Mechatronics::MechatronicsManager::PasteSystemObject ( NXOpen::Mechatronics::SystemObject parent)

Pastes the system engeering objects from the clipboard.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
parentparent
void NXOpen::Mechatronics::MechatronicsManager::PasteTraceLink ( NXOpen::Mechatronics::SystemObject object)

Adds existing requirement as tracelink of specified object.


Deprecated:
Deprecated in NX9.0.0. Please use SystemObject::CreateTraceLink instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
objectobject
void NXOpen::Mechatronics::MechatronicsManager::RefreshFromTeamcenter ( bool  bFunction,
bool  bLogical 
)

Refreshes function and(or) logical model from teamcenter.


Deprecated:
Deprecated in NX9.0.0. Please use another method with the same name instead.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
bFunctionbfunction
bLogicalblogical
void NXOpen::Mechatronics::MechatronicsManager::RefreshFromTeamcenter ( bool  requirement,
bool  function,
bool  logic 
)

Refreshes data model in system navigator from teamcenter.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
requirementRefresh the Requirement Model?
functionRefresh the Function Model?
logicRefresh the Logical Model?
NXOpen::Mechatronics::RequirementCollection* NXOpen::Mechatronics::MechatronicsManager::RequirementCollection ( )

Returns the RequirementCollection instance belonging to this part
Created in NX8.5.0.


void NXOpen::Mechatronics::MechatronicsManager::SaveToTeamcenter ( )

Saves the data model to teamcenter.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::MechatronicsManager::SaveToTeamcenter ( bool  requirement,
bool  function,
bool  logic 
)

Saves the data model to teamcenter.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
requirementSave the Requirement Model?
functionSave the Function Model?
logicSave the Logical Model?
tag_t NXOpen::Mechatronics::MechatronicsManager::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.