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

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

Created in NX8.0.0. More...

Public Member Functions

void ClosePart (NXOpen::NXObject *part, NXOpen::BasePart::CloseWholeTree wholeTree, NXOpen::BasePart::CloseModified closeModified)
 Close an existing part
Created in NX9.0.2. More...
 
NXOpen::Tooling::CloneObjectCreateCloneObject (NXOpen::Tooling::ToolingApplication applicationType, NXOpen::Tooling::ToolingCloneaction cloneActionType)
 Creates the clone operation object. More...
 
void CreateComponentPattern (NXOpen::NXObject *component, NXOpen::NXObject *targetEntity)
 Create component pattern
Created in NX11.0.2. More...
 
NXOpen::Tooling::SpreadsheetDataCreateSpreadsheetData ()
 Creates an instance of class NXOpen::Tooling::SpreadsheetData . More...
 
std::vector
< NXOpen::Assemblies::Component * > 
GetReusableComponent ()
 Gets the reusable component. More...
 
void GetReusableObjects (NXOpen::NXObject *part, std::vector< NXOpen::NXObject * > &reusableObjects)
 Gets the last added reusable object
Created in NX10.0.0. More...
 
NXOpen::BasePartLoadReusablePart (const NXString &filename, bool isNativePart)
 Opens an existing part, but does not set it to be the displayed part. More...
 
NXOpen::BasePartLoadReusablePart (const char *filename, bool isNativePart)
 Opens an existing part, but does not set it to be the displayed part. More...
 
void SetWizardType (int type)
 Sets the wizard type of tooling application. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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

Created in NX8.0.0.


Member Function Documentation

void NXOpen::Tooling::ToolingSession::ClosePart ( NXOpen::NXObject part,
NXOpen::BasePart::CloseWholeTree  wholeTree,
NXOpen::BasePart::CloseModified  closeModified 
)

Close an existing part
Created in NX9.0.2.



License requirements : None

Parameters
partTag of the part that will be closed
wholeTreeIf true, unloads all components of the part. If false, unloads only the top-level part
closeModifiedBehavior of close if component parts are modified.
NXOpen::Tooling::CloneObject* NXOpen::Tooling::ToolingSession::CreateCloneObject ( NXOpen::Tooling::ToolingApplication  applicationType,
NXOpen::Tooling::ToolingCloneaction  cloneActionType 
)

Creates the clone operation object.

Returns
the new NXOpen::Tooling::CloneObject instance
Created in NX8.0.0.

License requirements : None
Parameters
applicationTypeApplication type to determine the clone settings
cloneActionTypeClone action type
void NXOpen::Tooling::ToolingSession::CreateComponentPattern ( NXOpen::NXObject component,
NXOpen::NXObject targetEntity 
)

Create component pattern
Created in NX11.0.2.



License requirements : None

Parameters
componentcomponent
targetEntitytargetentity
NXOpen::Tooling::SpreadsheetData* NXOpen::Tooling::ToolingSession::CreateSpreadsheetData ( )

Creates an instance of class NXOpen::Tooling::SpreadsheetData .

Please note this method will only create an empty class NXOpen::Tooling::SpreadsheetData object, it needs to call other method NXOpen::Tooling::SpreadsheetData::ReadData to retrieve the data.

Returns
the new NXOpen::Tooling::SpreadsheetData instance
Created in NX8.0.0.

License requirements : None
std::vector<NXOpen::Assemblies::Component *> NXOpen::Tooling::ToolingSession::GetReusableComponent ( )

Gets the reusable component.

Returns
The array of reuseable components
Created in NX9.0.0.

License requirements : None
void NXOpen::Tooling::ToolingSession::GetReusableObjects ( NXOpen::NXObject part,
std::vector< NXOpen::NXObject * > &  reusableObjects 
)

Gets the last added reusable object
Created in NX10.0.0.



License requirements : None

Parameters
partTag of the part that contains reusable objects
reusableObjectsObjects, mainly bodies, from the input part
NXOpen::BasePart* NXOpen::Tooling::ToolingSession::LoadReusablePart ( const NXString filename,
bool  isNativePart 
)

Opens an existing part, but does not set it to be the displayed part.

Returns
Part Tag
Created in NX9.0.1.

License requirements : None
Parameters
filenameName of part file
isNativePartIs the file from native or TC
NXOpen::BasePart* NXOpen::Tooling::ToolingSession::LoadReusablePart ( const char *  filename,
bool  isNativePart 
)

Opens an existing part, but does not set it to be the displayed part.

Returns
Part Tag
Created in NX9.0.1.

License requirements : None
Parameters
filenameName of part file
isNativePartIs the file from native or TC
void NXOpen::Tooling::ToolingSession::SetWizardType ( int  type)

Sets the wizard type of tooling application.


Created in NX11.0.2.

License requirements : None

Parameters
typewizard type of current tooling application
tag_t NXOpen::Tooling::ToolingSession::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.