NX Open C++ Reference Guide
|
Represents the NX session. More...
Classes | |
struct | UndoMarkData |
This structure contains data about an undo mark. More... | |
Public Member Functions | |
NXOpen::Sketch * | ActiveSketch () |
Returns the active sketch Created in NX3.0.0. More... | |
NXOpen::CAE::AfuManager * | AfuManager () |
Returns the NXOpen::CAE::AfuManager belonging to this session Created in NX3.0.0. More... | |
NXString | ApplicationName () |
Returns the name of the current application. More... | |
void | ApplicationSwitchImmediate (const NXString &applicationName) |
Registers a request to immediately switch to the specified application and open the corresponding user environment. More... | |
void | ApplicationSwitchImmediate (const char *applicationName) |
Registers a request to immediately switch to the specified application and open the corresponding user environment. More... | |
NXOpen::AssembliesUtils * | AssembliesUtils () |
Returns the NXOpen::AssembliesUtils instance belonging to this session Created in NX3.0.0. More... | |
void | AssignRemoveProjects (std::vector< NXString > &cliNames, const std::vector< NXOpen::Session::ProjectAssignmentObjectType > &objectTypes, std::vector< NXString > &projectNames, const std::vector< NXOpen::Session::ProjectAssignmentState > &assignmentStates) |
Assign or remove projects to/from objects Created in NX6.0.0. More... | |
void | AssignRemoveProjectsBasedOnPartOccs (const std::vector< NXOpen::TaggedObject * > &partOccs, const std::vector< NXOpen::Session::ProjectAssignmentObjectType > &objectTypes, std::vector< NXString > &projectNames, const std::vector< NXOpen::Session::ProjectAssignmentState > &assignmentStates) |
Assign or remove projects to/from CPD objects Created in NX8.5.0. More... | |
NXOpen::AttributeManager * | AttributeManager () |
Returns the NXOpen::AttributeManager belonging to this session Created in NX8.5.0. More... | |
void | BeginTaskEnvironment () |
This method is called by the NX user interface before entering a task environment. More... | |
NXOpen::Gateway::BookmarkFile * | BookmarkFile () |
Returns the NXOpen::Gateway::BookmarkFile belonging to this session Created in NX10.0.0. More... | |
NXOpen::CAE::CaeSession * | CaeSession () |
Returns the NXOpen::CAE::CaeSession belonging to this session Created in NX7.5.0. More... | |
NXOpen::CAM::CAMSession * | CAMSession () |
Returns the CAM session Created in NX3.0.0. More... | |
void | CleanUpFacetedFacesAndEdges () |
Deletes all NXOpen::Facet::FacetedFace and NXOpen::Facet::FacetedEdge objects in the current session Created in NX5.0.0. More... | |
NXOpen::CollaborativeContentManager * | CollaborativeContentManager () |
Returns the NXOpen::CollaborativeContentManager belonging to this session Created in NX8.5.0. More... | |
NXOpen::PDM::ConfigurationManager * | ConfigurationManager () |
Returns the NXOpen::PDM::ConfigurationManager belonging to this session Created in NX9.0.0. More... | |
void | CreateCamSession () |
Create the CAM session Created in NX4.0.0. More... | |
void | CreateInspectionSession () |
Create the Inspection session Created in NX7.0.0. More... | |
NXOpen::TableEditorDefaultDataProvider * | CreateTableEditorDefaultDataProvider (NXOpen::BasePart *part) |
Creates a data provider for a table editor. More... | |
NXOpen::CAE::FTK::DataManager * | DataManager () |
Returns the NXOpen::CAE::FTK::DataManager belonging to this session Created in NX7.5.0. More... | |
void | DeleteAllUndoMarks () |
Deletes all undo marks Created in NX3.0.0. More... | |
bool | DeleteTransientDynamicSectionCutData () |
Delete transient data associated with NXOpen::Display::DynamicSectionCut objects in the session. More... | |
void | DeleteUndoMark (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Deletes an undo mark. More... | |
void | DeleteUndoMark (NXOpen::Session::UndoMarkId markId, const char *markName) |
Deletes an undo mark. More... | |
void | DeleteUndoMarksSetInTaskEnvironment () |
This method deletes all the undo marks that have been created since entering the task environment via NXOpen::Session::BeginTaskEnvironment . More... | |
void | DeleteUndoMarksUpToMark (NXOpen::Session::UndoMarkId markId, const NXString &markName, bool deleteAllIfNotFound) |
Deletes all undo marks up to and including the specified mark. More... | |
void | DeleteUndoMarksUpToMark (NXOpen::Session::UndoMarkId markId, const char *markName, bool deleteAllIfNotFound) |
Deletes all undo marks up to and including the specified mark. More... | |
NXOpen::Routing::DesignRuleManager * | DesignRuleManager () |
Returns the DesignRule Created in NX3.0.0. More... | |
NXOpen::DexManager * | DexManager () |
Returns the NXOpen::DexManager belonging to this session Created in NX3.0.0. More... | |
NXOpen::DisplayManager * | DisplayManager () |
Returns the NXOpen::DisplayManager belonging to this session Created in NX3.0.0. More... | |
bool | DoesUndoMarkExist (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Returns true if the specified mark exists. More... | |
bool | DoesUndoMarkExist (NXOpen::Session::UndoMarkId markId, const char *markName) |
Returns true if the specified mark exists. More... | |
NXOpen::DrawingUtils * | DrawingUtils () |
Returns the NXOpen::DrawingUtils instance belonging to this session Created in NX8.5.3. More... | |
bool | EnableRedo (bool enableRedo) |
Enable redo for NXOpen programs. More... | |
void | EndTaskEnvironment () |
This method is called by the NX user interface when leaving a task environment. More... | |
NXOpen::EngineeringFunction * | EngineeringFunction () |
Returns the NXOpen::EngineeringFunction instance belonging to this session Created in NX3.0.0. More... | |
NXString | ExecutingJournal () |
Returns the full path to the journal that is currently being executed Created in NX3.0.0. More... | |
void | ExitPartNavigator () |
Exits the part navigator Created in NX10.0.0. More... | |
NXOpen::CAE::FTK::FTKManager * | FTKManager () |
Returns the NXOpen::CAE::FTK::FTKManager belonging to this session Created in NX3.0.0. More... | |
std::vector < NXOpen::Session::UndoMarkData > | GetAllUndoMarks (NXOpen::Session::MarkVisibility visibility) |
Returns a list of all the undo marks with the specified visibility. More... | |
std::vector< NXString > | GetClasses () |
Gets a list of the classes defined in the current session. More... | |
NXString | GetEnvironmentVariableValue (const NXString &envVaribable) |
Returns the value of a NX enviroment variable. More... | |
NXString | GetEnvironmentVariableValue (const char *envVaribable) |
Returns the value of a NX enviroment variable. More... | |
std::vector< NXString > | GetNamedProperties (NXOpen::TaggedObject *object) |
Gets a list of the named properties of this object. More... | |
void | GetNamedProperties (const NXString &className, std::vector< NXString > &properties, std::vector< NXString > &propertyTypes) |
Gets a list of the named properties of a named class Created in NX5.0.0. More... | |
void | GetNamedProperties (const char *className, std::vector< NXString > &properties, std::vector< NXString > &propertyTypes) |
Gets a list of the named properties of a named class Created in NX5.0.0. More... | |
NXOpen::Session::UndoMarkId | GetNewestUndoMark (NXOpen::Session::MarkVisibility visibility) |
Returns the newest undo mark with the specified visibility. More... | |
NXString | GetProperty (NXOpen::TaggedObject *object, const NXString &propertyName) |
Gets a named property of the object. More... | |
NXString | GetProperty (NXOpen::TaggedObject *object, const char *propertyName) |
Gets a named property of the object. More... | |
NXString | GetUndoMarkName (NXOpen::Session::UndoMarkId markId) |
Returns the name of the specified undo mark. More... | |
NXOpen::Session::MarkVisibility | GetUndoMarkVisibility (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Returns the visibility of the specified undo mark. More... | |
NXOpen::Session::MarkVisibility | GetUndoMarkVisibility (NXOpen::Session::UndoMarkId markId, const char *markName) |
Returns the visibility of the specified undo mark. More... | |
NXOpen::Information * | Information () |
Returns the NXOpen::Information instance belonging to this session Created in NX3.0.0. More... | |
bool | IsBatch () |
Returns true if and only if NX is batch mode (or in other words not running interactively). More... | |
bool | IsCamSessionInitialized () |
Check if the CAM session is initialized. More... | |
bool | IsInspectionSessionInitialized () |
Check if the Inspection session is initialized. More... | |
bool | IsInTaskEnvironment () |
Returns true if and only if NX is in a task environment Created in NX3.0.0. More... | |
bool | IsPartNavigatorOpen () |
Check if the Part Navigator is open or close. More... | |
NXOpen::Issue::IssueManager * | IssueManager () |
Returns the NXOpen::Issue::IssueManager belonging to this session Created in NX8.5.0. More... | |
NXOpen::LicenseManager * | LicenseManager () |
Returns the NXOpen::LicenseManager belonging to this session Created in NX3.0.0. More... | |
NXOpen::LinkedPartManager * | LinkedPartManager () |
Returns the NXOpen::LinkedPartManager belonging to this session Created in NX8.5.0. More... | |
NXOpen::ListingWindow * | ListingWindow () |
Returns the NXOpen::ListingWindow belonging to this session Created in NX3.0.0. More... | |
NXOpen::LogFile * | LogFile () |
Returns the log file instance for this session Created in NX3.0.0. More... | |
NXOpen::Markup::MarkupManager * | MarkupManager () |
Returns the NXOpen::Markup::MarkupManager instance belonging to this session Created in NX10.0.0. More... | |
NXOpen::MathUtils * | MathUtils () |
Returns the NXOpen::MathUtils instance belonging to this session Created in NX3.0.0. More... | |
NXOpen::Measurement * | Measurement () |
Returns the NXOpen::Measurement instance belonging to this session Created in NX3.0.0. More... | |
NXOpen::Mechatronics::MechatronicsSession * | MechatronicsSession () |
Returns the NXOpen::Mechatronics::MechatronicsSession belonging to this session Created in NX9.0.0. More... | |
NXOpen::Motion::MotionSession * | MotionSession () |
Returns the Motion session Created in NX3.0.0. More... | |
NXOpen::Motion::MotionSimulation * | MotionSimulation () |
Returns the Motion session Created in NX3.0.0. More... | |
NXOpen::CAE::GRMSearch * | NewCaeGrmsearch () |
Creates a new CAE GRM Search object. More... | |
NXOpen::PDM::PersistentSettings * | NewDatabasePersistentOptions () |
Creates a new database persistent option controller. More... | |
NXOpen::PDM::SessionSettings * | NewDatabaseSessionOptions () |
Creates a new database session option controller. More... | |
NXOpen::ErrorList * | NewErrorList () |
Creates a new error list. More... | |
NXOpen::Session::UndoMarkId | NewestVisibleUndoMark () |
Returns the newest visible undo mark Created in NX3.0.0. More... | |
NXOpen::PartCleanup * | NewPartCleanup () |
Constructs a new PartCleanup object. More... | |
NXOpen::Display::TransientText * | NewTransientText () |
Returns a new NXOpen::Display::TransientText object. More... | |
void | OpenPartNavigator () |
Opens the part navigator Created in NX10.0.0. More... | |
NXOpen::Options::OptionsManager * | OptionsManager () |
Returns the NXOpen::Options::OptionsManager instance belonging to this session Created in NX3.0.0. More... | |
NXOpen::PartCollection * | Parts () |
Returns the NXOpen::PartCollection belonging to this session Created in NX3.0.0. More... | |
NXOpen::PDM::PdmSearchManager * | PdmSearchManager () |
Returns the NXOpen::PDM::PdmSearchManager instance belonging to this session Created in NX3.0.0. More... | |
NXOpen::PDM::PdmSession * | PdmSession () |
Returns the NXOpen::PDM::PdmSession belonging to this session Created in NX7.5.0. More... | |
NXOpen::CAE::Post * | Post () |
Returns the NXOpen::CAE::Post belonging to this session Created in NX3.0.0. More... | |
NXOpen::Preferences::SessionPreferences * | Preferences () |
Returns the preferences instance for the session Created in NX3.0.0. More... | |
NXOpen::PvtransManager * | PvtransManager () |
Returns the NXOpen::PvtransManager belonging to this session Created in NX8.5.0. More... | |
void | Redo () |
Redo the last undo if possible. More... | |
NXOpen::PDM::RequirementUtils * | RequirementUtils () |
Returns the NXOpen::PDM::RequirementUtils instance belonging to this session Created in NX6.0.3. More... | |
NXOpen::CAE::ResultManager * | ResultManager () |
Returns the NXOpen::CAE::ResultManager belonging to this session Created in NX6.0.2. More... | |
void | SetEnvironmentVariableValue (const NXString &envVaribable, const NXString &envValue) |
Sets the value of a NX enviroment variable Created in NX7.5.1. More... | |
void | SetEnvironmentVariableValue (const char *envVaribable, const char *envValue) |
Sets the value of a NX enviroment variable Created in NX7.5.1. More... | |
void | SetProperty (NXOpen::TaggedObject *object, const NXString &propertyName, const NXString &value) |
Sets a named property of the object. More... | |
void | SetProperty (NXOpen::TaggedObject *object, const char *propertyName, const char *value) |
Sets a named property of the object. More... | |
void | SetTransientPartPersistencePolicy (NXOpen::Session::TransientPartPolicy policy) |
Sets the persistence policy for transient parts in the session Created in NX4.0.0. More... | |
NXOpen::Session::UndoMarkId | SetUndoMark (NXOpen::Session::MarkVisibility markVisibility, const NXString &name) |
Creates an undo mark. More... | |
NXOpen::Session::UndoMarkId | SetUndoMark (NXOpen::Session::MarkVisibility markVisibility, const char *name) |
Creates an undo mark. More... | |
void | SetUndoMarkName (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Sets the name of the undo mark Created in NX3.0.0. More... | |
void | SetUndoMarkName (NXOpen::Session::UndoMarkId markId, const char *markName) |
Sets the name of the undo mark Created in NX3.0.0. More... | |
void | SetUndoMarkVisibility (NXOpen::Session::UndoMarkId markId, const NXString &markName, NXOpen::Session::MarkVisibility visibility) |
Sets the visibility of the specified undo mark Created in NX3.0.0. More... | |
void | SetUndoMarkVisibility (NXOpen::Session::UndoMarkId markId, const char *markName, NXOpen::Session::MarkVisibility visibility) |
Sets the visibility of the specified undo mark Created in NX3.0.0. More... | |
NXOpen::SubdivisionTaskEnvironment * | SubdivisionTaskEnvironment () |
Returns the NXOpen::SubdivisionTaskEnvironment belonging to this session Created in NX9.0.0. More... | |
NXOpen::Tooling::ToolingSession * | ToolingSession () |
Returns the NXOpen::Tooling::ToolingSession belonging to this session Created in NX8.0.0. More... | |
NXOpen::Session::TransientPartPolicy | TransientPartPersistencePolicy () |
Returns the persistence policy for transient parts in the session Created in NX4.0.0. More... | |
void | UndoLastNVisibleMarks (int n, bool *marksRecycled, bool *undoUnavailable) |
Undo to a specified number of visible marks starting with the most recently created visible mark. More... | |
void | UndoToLastVisibleMark () |
Undo to last visible mark. More... | |
void | UndoToMark (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Undo to the specified mark Created in NX3.0.0. More... | |
void | UndoToMark (NXOpen::Session::UndoMarkId markId, const char *markName) |
Undo to the specified mark Created in NX3.0.0. More... | |
void | UndoToMarkWithStatus (NXOpen::Session::UndoMarkId markId, const NXString &markName) |
Undo to the specified mark and output status to status bar. More... | |
void | UndoToMarkWithStatus (NXOpen::Session::UndoMarkId markId, const char *markName) |
Undo to the specified mark and output status to status bar. More... | |
NXOpen::Update * | UpdateManager () |
Returns the NXOpen::Update belonging to this session Created in NX3.0.0. More... | |
NXOpen::UserDefinedObjects::UserDefinedClassManager * | UserDefinedClassManager () |
Returns the NXOpen::UserDefinedObjects::UserDefinedClassManager belonging to this session Created in NX3.0.0. More... | |
NXOpen::Features::UserDefinedFeatureClassManager * | UserDefinedFeatureClassManager () |
Returns the NXOpen::Features::UserDefinedFeatureClassManager belonging to this session Created in NX8.0.0. More... | |
NXOpen::Validate::ValidationManager * | ValidationManager () |
Returns the NXOpen::Validate::ValidationManager belonging to this session Created in NX7.5.0. More... | |
NXOpen::VisualReporting::VisualReportManager * | VisualReportManager () |
Returns the NXOpen::VisualReporting::VisualReportManager instance belonging to this session Created in NX7.0.0. More... | |
NXOpen::Weld::WeldCpdUtils * | WeldCpdUtils () |
Returns the NXOpen::Weld::WeldCpdUtils instance belonging to this session Created in NX9.0.0. More... | |
NXOpen::Weld::CustomManager * | WeldCustomManager () |
Returns the NXOpen::Weld::CustomManager belonging to this session Created in NX8.0.0. More... | |
NXOpen::Validate::XmlComparator * | XmlComparator () |
Returns the NXOpen::Validate::XmlComparator instance belonging to this session Created in NX6.0.2. More... | |
NXOpen::CAE::Xyplot::XYPlotManager * | XYPlotManager () |
Returns the NXOpen::CAE::Xyplot::XYPlotManager belonging to this session Created in NX7.5.0. More... | |
Static Public Member Functions | |
static Session * | GetSession () |
Represents the NX session.
For language bindings that support remoting, the server must export it for this class to be obtained by a client.
Created in NX3.0.0.
Describes when an automation library should be unloaded from a running session.
To use the enum, implement a static function called GetUnloadOption in your automation program which returns one of these options as an integer. (Note that this function must also have a string argument that is currently not used for anything.) NX will call this method once the automation program has exited to determine when to unload the library.
Enumerator | |
---|---|
LibraryUnloadOptionExplicitly |
unload the library from the "Unload Shared Image" dialog |
LibraryUnloadOptionAtTermination |
unload the library when the NX session terminates |
Indicates whether project assignment is for item, item revision or dataset.
Represents a undo mark.
This is used to rollback to previous states of the model.
NXOpen::Sketch* NXOpen::Session::ActiveSketch | ( | ) |
Returns the active sketch
Created in NX3.0.0.
License requirements : None
NXOpen::CAE::AfuManager* NXOpen::Session::AfuManager | ( | ) |
Returns the NXOpen::CAE::AfuManager belonging to this session
Created in NX3.0.0.
NXString NXOpen::Session::ApplicationName | ( | ) |
Returns the name of the current application.
Created in NX10.0.0.
License requirements : None
void NXOpen::Session::ApplicationSwitchImmediate | ( | const NXString & | applicationName | ) |
Registers a request to immediately switch to the specified application and open the corresponding user environment.
The current application will change immediately. The argument is an application button name as specified and registered in a Menuscript file. For example specify UG_APP_MODELING to enter the modeling application.
Created in NX10.0.0.
License requirements : None
applicationName | Button name of requested application NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::ApplicationSwitchImmediate | ( | const char * | applicationName | ) |
Registers a request to immediately switch to the specified application and open the corresponding user environment.
The current application will change immediately. The argument is an application button name as specified and registered in a Menuscript file. For example specify UG_APP_MODELING to enter the modeling application.
Created in NX10.0.0.
License requirements : None
applicationName | Button name of requested application NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::AssembliesUtils* NXOpen::Session::AssembliesUtils | ( | ) |
Returns the NXOpen::AssembliesUtils instance belonging to this session
Created in NX3.0.0.
void NXOpen::Session::AssignRemoveProjects | ( | std::vector< NXString > & | cliNames, |
const std::vector< NXOpen::Session::ProjectAssignmentObjectType > & | objectTypes, | ||
std::vector< NXString > & | projectNames, | ||
const std::vector< NXOpen::Session::ProjectAssignmentState > & | assignmentStates | ||
) |
Assign or remove projects to/from objects
Created in NX6.0.0.
License requirements : None
cliNames | cli names of the objects to assign projects to NOTE: The full Unicode character set is not supported for this parameter. |
objectTypes | one of item, item rev or dataset type |
projectNames | names of the projects to assign NOTE: The full Unicode character set is not supported for this parameter. |
assignmentStates | assignment states |
void NXOpen::Session::AssignRemoveProjectsBasedOnPartOccs | ( | const std::vector< NXOpen::TaggedObject * > & | partOccs, |
const std::vector< NXOpen::Session::ProjectAssignmentObjectType > & | objectTypes, | ||
std::vector< NXString > & | projectNames, | ||
const std::vector< NXOpen::Session::ProjectAssignmentState > & | assignmentStates | ||
) |
Assign or remove projects to/from CPD objects
Created in NX8.5.0.
License requirements : None
partOccs | Array of components to assign/remove projects to |
objectTypes | currently only DE |
projectNames | names of the projects to assign NOTE: The full Unicode character set is not supported for this parameter. |
assignmentStates | assignment states |
NXOpen::AttributeManager* NXOpen::Session::AttributeManager | ( | ) |
Returns the NXOpen::AttributeManager belonging to this session
Created in NX8.5.0.
void NXOpen::Session::BeginTaskEnvironment | ( | ) |
This method is called by the NX user interface before entering a task environment.
This method will make invisible all the undo marks that currently exist. The reason for doing this is so that the user sees only the undo marks created in the task environment. The method NXOpen::Session::EndTaskEnvironment will restore the marks to the visibility that they had before this method was called. This method should not be called if NX is already in a task environment.
Created in NX3.0.0.
License requirements : None
NXOpen::Gateway::BookmarkFile* NXOpen::Session::BookmarkFile | ( | ) |
Returns the NXOpen::Gateway::BookmarkFile belonging to this session
Created in NX10.0.0.
NXOpen::CAE::CaeSession* NXOpen::Session::CaeSession | ( | ) |
Returns the NXOpen::CAE::CaeSession belonging to this session
Created in NX7.5.0.
NXOpen::CAM::CAMSession* NXOpen::Session::CAMSession | ( | ) |
Returns the CAM session
Created in NX3.0.0.
void NXOpen::Session::CleanUpFacetedFacesAndEdges | ( | ) |
Deletes all NXOpen::Facet::FacetedFace and NXOpen::Facet::FacetedEdge objects in the current session
Created in NX5.0.0.
License requirements : None
NXOpen::CollaborativeContentManager* NXOpen::Session::CollaborativeContentManager | ( | ) |
Returns the NXOpen::CollaborativeContentManager belonging to this session
Created in NX8.5.0.
NXOpen::PDM::ConfigurationManager* NXOpen::Session::ConfigurationManager | ( | ) |
Returns the NXOpen::PDM::ConfigurationManager belonging to this session
Created in NX9.0.0.
void NXOpen::Session::CreateCamSession | ( | ) |
Create the CAM session
Created in NX4.0.0.
License requirements : None
void NXOpen::Session::CreateInspectionSession | ( | ) |
Create the Inspection session
Created in NX7.0.0.
License requirements : None
NXOpen::TableEditorDefaultDataProvider* NXOpen::Session::CreateTableEditorDefaultDataProvider | ( | NXOpen::BasePart * | part | ) |
Creates a data provider for a table editor.
part | The part that owns the data provider. The owner is not strictly required (that is, it can be NULL), but its use is suggested if a part exists to ensure proper cleanup of the builder in case the client does not explicitly clean it up properly. |
NXOpen::CAE::FTK::DataManager* NXOpen::Session::DataManager | ( | ) |
Returns the NXOpen::CAE::FTK::DataManager belonging to this session
Created in NX7.5.0.
void NXOpen::Session::DeleteAllUndoMarks | ( | ) |
Deletes all undo marks
Created in NX3.0.0.
License requirements : None
bool NXOpen::Session::DeleteTransientDynamicSectionCutData | ( | ) |
Delete transient data associated with NXOpen::Display::DynamicSectionCut objects in the session.
One example of transient data generation is measurement to a dynamic section-cut. Transient section curves are generated in order to perform non-associative measurement. These transient curves are destroyed once measurement operation is finished.
void NXOpen::Session::DeleteUndoMark | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Deletes an undo mark.
If you want to delete a mark and all marks that were created after that mark, use DeleteUndoMarksUpToMark instead.
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::DeleteUndoMark | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Deletes an undo mark.
If you want to delete a mark and all marks that were created after that mark, use DeleteUndoMarksUpToMark instead.
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::DeleteUndoMarksSetInTaskEnvironment | ( | ) |
This method deletes all the undo marks that have been created since entering the task environment via NXOpen::Session::BeginTaskEnvironment .
An exception will be thrown if this method is called when NX is not in a task environment.
Created in NX3.0.0.
License requirements : None
void NXOpen::Session::DeleteUndoMarksUpToMark | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName, | ||
bool | deleteAllIfNotFound | ||
) |
Deletes all undo marks up to and including the specified mark.
If you only want to delete a mark, but do not want to delete the marks that were created after that mark, use DeleteUndoMark instead.
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
deleteAllIfNotFound | Whether to delete all marks if the specified mark is not found |
void NXOpen::Session::DeleteUndoMarksUpToMark | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName, | ||
bool | deleteAllIfNotFound | ||
) |
Deletes all undo marks up to and including the specified mark.
If you only want to delete a mark, but do not want to delete the marks that were created after that mark, use DeleteUndoMark instead.
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
deleteAllIfNotFound | Whether to delete all marks if the specified mark is not found |
NXOpen::Routing::DesignRuleManager* NXOpen::Session::DesignRuleManager | ( | ) |
Returns the DesignRule
Created in NX3.0.0.
NXOpen::DexManager* NXOpen::Session::DexManager | ( | ) |
Returns the NXOpen::DexManager belonging to this session
Created in NX3.0.0.
NXOpen::DisplayManager* NXOpen::Session::DisplayManager | ( | ) |
Returns the NXOpen::DisplayManager belonging to this session
Created in NX3.0.0.
bool NXOpen::Session::DoesUndoMarkExist | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Returns true if the specified mark exists.
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
bool NXOpen::Session::DoesUndoMarkExist | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Returns true if the specified mark exists.
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::DrawingUtils* NXOpen::Session::DrawingUtils | ( | ) |
Returns the NXOpen::DrawingUtils instance belonging to this session
Created in NX8.5.3.
bool NXOpen::Session::EnableRedo | ( | bool | enableRedo | ) |
Enable redo for NXOpen programs.
As default redo is enabled in NX. One can disable redo to save memory for memory intensive NX Open programs. After the NX Open program is executed redo will be restored back to enabled state. In case redo is enabled from previous disbaled state , it must be done just before setting a undo mark. Note that, redo is not supported for the visible marks set before making this call.
enableRedo | True will enable redo for NXOpen programs. False should disable the redo for NXOpen programs |
void NXOpen::Session::EndTaskEnvironment | ( | ) |
This method is called by the NX user interface when leaving a task environment.
This method will make visible all the undo marks that were made invisible by NXOpen::Session::BeginTaskEnvironment . An exception will be thrown if this method is called when NX is not in a task environment.
Created in NX3.0.0.
License requirements : None
NXOpen::EngineeringFunction* NXOpen::Session::EngineeringFunction | ( | ) |
Returns the NXOpen::EngineeringFunction instance belonging to this session
Created in NX3.0.0.
NXString NXOpen::Session::ExecutingJournal | ( | ) |
Returns the full path to the journal that is currently being executed
Created in NX3.0.0.
License requirements : None
void NXOpen::Session::ExitPartNavigator | ( | ) |
Exits the part navigator
Created in NX10.0.0.
License requirements : None
NXOpen::CAE::FTK::FTKManager* NXOpen::Session::FTKManager | ( | ) |
Returns the NXOpen::CAE::FTK::FTKManager belonging to this session
Created in NX3.0.0.
std::vector<NXOpen::Session::UndoMarkData> NXOpen::Session::GetAllUndoMarks | ( | NXOpen::Session::MarkVisibility | visibility | ) |
Returns a list of all the undo marks with the specified visibility.
visibility | Used to limit the results to marks with the specified visibility |
std::vector<NXString> NXOpen::Session::GetClasses | ( | ) |
Gets a list of the classes defined in the current session.
Returns the value of a NX enviroment variable.
envVaribable | the environment variable name, which may be case sensitive on some platforms NOTE: The full Unicode character set is not supported for this parameter. |
NXString NXOpen::Session::GetEnvironmentVariableValue | ( | const char * | envVaribable | ) |
Returns the value of a NX enviroment variable.
envVaribable | the environment variable name, which may be case sensitive on some platforms NOTE: The full Unicode character set is not supported for this parameter. |
std::vector<NXString> NXOpen::Session::GetNamedProperties | ( | NXOpen::TaggedObject * | object | ) |
Gets a list of the named properties of this object.
object | The object to query |
void NXOpen::Session::GetNamedProperties | ( | const NXString & | className, |
std::vector< NXString > & | properties, | ||
std::vector< NXString > & | propertyTypes | ||
) |
Gets a list of the named properties of a named class
Created in NX5.0.0.
License requirements : None
className | The name of the class to query NOTE: The full Unicode character set is not supported for this parameter. |
properties | array of property names |
propertyTypes | type name of corresponding property |
void NXOpen::Session::GetNamedProperties | ( | const char * | className, |
std::vector< NXString > & | properties, | ||
std::vector< NXString > & | propertyTypes | ||
) |
Gets a list of the named properties of a named class
Created in NX5.0.0.
License requirements : None
className | The name of the class to query NOTE: The full Unicode character set is not supported for this parameter. |
properties | array of property names |
propertyTypes | type name of corresponding property |
NXOpen::Session::UndoMarkId NXOpen::Session::GetNewestUndoMark | ( | NXOpen::Session::MarkVisibility | visibility | ) |
Returns the newest undo mark with the specified visibility.
visibility | the visibility mask |
NXString NXOpen::Session::GetProperty | ( | NXOpen::TaggedObject * | object, |
const NXString & | propertyName | ||
) |
Gets a named property of the object.
The property names are based upon the properties provided by the NXOpen API.
object | The object to query |
propertyName | The name of the property NOTE: The full Unicode character set is not supported for this parameter. |
NXString NXOpen::Session::GetProperty | ( | NXOpen::TaggedObject * | object, |
const char * | propertyName | ||
) |
Gets a named property of the object.
The property names are based upon the properties provided by the NXOpen API.
object | The object to query |
propertyName | The name of the property NOTE: The full Unicode character set is not supported for this parameter. |
NXString NXOpen::Session::GetUndoMarkName | ( | NXOpen::Session::UndoMarkId | markId | ) |
Returns the name of the specified undo mark.
markId | ID of the mark |
NXOpen::Session::MarkVisibility NXOpen::Session::GetUndoMarkVisibility | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Returns the visibility of the specified undo mark.
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::Session::MarkVisibility NXOpen::Session::GetUndoMarkVisibility | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Returns the visibility of the specified undo mark.
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::Information* NXOpen::Session::Information | ( | ) |
Returns the NXOpen::Information instance belonging to this session
Created in NX3.0.0.
bool NXOpen::Session::IsBatch | ( | ) |
Returns true if and only if NX is batch mode (or in other words not running interactively).
Created in NX8.0.3.
License requirements : None
bool NXOpen::Session::IsCamSessionInitialized | ( | ) |
Check if the CAM session is initialized.
bool NXOpen::Session::IsInspectionSessionInitialized | ( | ) |
Check if the Inspection session is initialized.
bool NXOpen::Session::IsInTaskEnvironment | ( | ) |
Returns true if and only if NX is in a task environment
Created in NX3.0.0.
License requirements : None
bool NXOpen::Session::IsPartNavigatorOpen | ( | ) |
Check if the Part Navigator is open or close.
NXOpen::Issue::IssueManager* NXOpen::Session::IssueManager | ( | ) |
Returns the NXOpen::Issue::IssueManager belonging to this session
Created in NX8.5.0.
NXOpen::LicenseManager* NXOpen::Session::LicenseManager | ( | ) |
Returns the NXOpen::LicenseManager belonging to this session
Created in NX3.0.0.
NXOpen::LinkedPartManager* NXOpen::Session::LinkedPartManager | ( | ) |
Returns the NXOpen::LinkedPartManager belonging to this session
Created in NX8.5.0.
NXOpen::ListingWindow* NXOpen::Session::ListingWindow | ( | ) |
Returns the NXOpen::ListingWindow belonging to this session
Created in NX3.0.0.
NXOpen::LogFile* NXOpen::Session::LogFile | ( | ) |
Returns the log file instance for this session
Created in NX3.0.0.
NXOpen::Markup::MarkupManager* NXOpen::Session::MarkupManager | ( | ) |
Returns the NXOpen::Markup::MarkupManager instance belonging to this session
Created in NX10.0.0.
NXOpen::MathUtils* NXOpen::Session::MathUtils | ( | ) |
Returns the NXOpen::MathUtils instance belonging to this session
Created in NX3.0.0.
NXOpen::Measurement* NXOpen::Session::Measurement | ( | ) |
Returns the NXOpen::Measurement instance belonging to this session
Created in NX3.0.0.
NXOpen::Mechatronics::MechatronicsSession* NXOpen::Session::MechatronicsSession | ( | ) |
Returns the NXOpen::Mechatronics::MechatronicsSession belonging to this session
Created in NX9.0.0.
NXOpen::Motion::MotionSession* NXOpen::Session::MotionSession | ( | ) |
Returns the Motion session
Created in NX3.0.0.
NXOpen::Motion::MotionSimulation* NXOpen::Session::MotionSimulation | ( | ) |
Returns the Motion session
Created in NX3.0.0.
NXOpen::CAE::GRMSearch* NXOpen::Session::NewCaeGrmsearch | ( | ) |
Creates a new CAE GRM Search object.
NXOpen::PDM::PersistentSettings* NXOpen::Session::NewDatabasePersistentOptions | ( | ) |
Creates a new database persistent option controller.
NXOpen::PDM::SessionSettings* NXOpen::Session::NewDatabaseSessionOptions | ( | ) |
Creates a new database session option controller.
NXOpen::ErrorList* NXOpen::Session::NewErrorList | ( | ) |
Creates a new error list.
Warning: this method may be removed in a future release
NXOpen::Session::UndoMarkId NXOpen::Session::NewestVisibleUndoMark | ( | ) |
Returns the newest visible undo mark
Created in NX3.0.0.
License requirements : None
NXOpen::PartCleanup* NXOpen::Session::NewPartCleanup | ( | ) |
Constructs a new PartCleanup object.
NXOpen::Display::TransientText* NXOpen::Session::NewTransientText | ( | ) |
Returns a new NXOpen::Display::TransientText object.
void NXOpen::Session::OpenPartNavigator | ( | ) |
Opens the part navigator
Created in NX10.0.0.
License requirements : None
NXOpen::Options::OptionsManager* NXOpen::Session::OptionsManager | ( | ) |
Returns the NXOpen::Options::OptionsManager instance belonging to this session
Created in NX3.0.0.
NXOpen::PartCollection* NXOpen::Session::Parts | ( | ) |
Returns the NXOpen::PartCollection belonging to this session
Created in NX3.0.0.
NXOpen::PDM::PdmSearchManager* NXOpen::Session::PdmSearchManager | ( | ) |
Returns the NXOpen::PDM::PdmSearchManager instance belonging to this session
Created in NX3.0.0.
NXOpen::PDM::PdmSession* NXOpen::Session::PdmSession | ( | ) |
Returns the NXOpen::PDM::PdmSession belonging to this session
Created in NX7.5.0.
NXOpen::CAE::Post* NXOpen::Session::Post | ( | ) |
Returns the NXOpen::CAE::Post belonging to this session
Created in NX3.0.0.
NXOpen::Preferences::SessionPreferences* NXOpen::Session::Preferences | ( | ) |
Returns the preferences instance for the session
Created in NX3.0.0.
NXOpen::PvtransManager* NXOpen::Session::PvtransManager | ( | ) |
Returns the NXOpen::PvtransManager belonging to this session
Created in NX8.5.0.
void NXOpen::Session::Redo | ( | ) |
Redo the last undo if possible.
Only does one mark but may be repeated for all redoable marks. Only marks undone by UndoLastNVisibleMarks are redoable.
Created in NX5.0.0.
License requirements : None
NXOpen::PDM::RequirementUtils* NXOpen::Session::RequirementUtils | ( | ) |
Returns the NXOpen::PDM::RequirementUtils instance belonging to this session
Created in NX6.0.3.
NXOpen::CAE::ResultManager* NXOpen::Session::ResultManager | ( | ) |
Returns the NXOpen::CAE::ResultManager belonging to this session
Created in NX6.0.2.
void NXOpen::Session::SetEnvironmentVariableValue | ( | const NXString & | envVaribable, |
const NXString & | envValue | ||
) |
Sets the value of a NX enviroment variable
Created in NX7.5.1.
License requirements : None
envVaribable | the environment variable name, which may be case sensitive on some platforms NOTE: The full Unicode character set is not supported for this parameter. |
envValue | the value to be assigned to this environment variable NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::SetEnvironmentVariableValue | ( | const char * | envVaribable, |
const char * | envValue | ||
) |
Sets the value of a NX enviroment variable
Created in NX7.5.1.
License requirements : None
envVaribable | the environment variable name, which may be case sensitive on some platforms NOTE: The full Unicode character set is not supported for this parameter. |
envValue | the value to be assigned to this environment variable NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::SetProperty | ( | NXOpen::TaggedObject * | object, |
const NXString & | propertyName, | ||
const NXString & | value | ||
) |
Sets a named property of the object.
The property names are based upon the properties provided by the NXOpen API.
Created in NX5.0.0.
License requirements : None
object | The object to query |
propertyName | The name of the property NOTE: The full Unicode character set is not supported for this parameter. |
value | The value of the property, expressed as a string |
void NXOpen::Session::SetProperty | ( | NXOpen::TaggedObject * | object, |
const char * | propertyName, | ||
const char * | value | ||
) |
Sets a named property of the object.
The property names are based upon the properties provided by the NXOpen API.
Created in NX5.0.0.
License requirements : None
object | The object to query |
propertyName | The name of the property NOTE: The full Unicode character set is not supported for this parameter. |
value | The value of the property, expressed as a string |
void NXOpen::Session::SetTransientPartPersistencePolicy | ( | NXOpen::Session::TransientPartPolicy | policy | ) |
Sets the persistence policy for transient parts in the session
Created in NX4.0.0.
License requirements : None
policy | policy |
NXOpen::Session::UndoMarkId NXOpen::Session::SetUndoMark | ( | NXOpen::Session::MarkVisibility | markVisibility, |
const NXString & | name | ||
) |
Creates an undo mark.
markVisibility | mark visibility |
name | mark name NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::Session::UndoMarkId NXOpen::Session::SetUndoMark | ( | NXOpen::Session::MarkVisibility | markVisibility, |
const char * | name | ||
) |
Creates an undo mark.
markVisibility | mark visibility |
name | mark name NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::SetUndoMarkName | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Sets the name of the undo mark
Created in NX3.0.0.
License requirements : None
markId | ID of the mark |
markName | Name of the mark. NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::SetUndoMarkName | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Sets the name of the undo mark
Created in NX3.0.0.
License requirements : None
markId | ID of the mark |
markName | Name of the mark. NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::SetUndoMarkVisibility | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName, | ||
NXOpen::Session::MarkVisibility | visibility | ||
) |
Sets the visibility of the specified undo mark
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
visibility | the new visibility |
void NXOpen::Session::SetUndoMarkVisibility | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName, | ||
NXOpen::Session::MarkVisibility | visibility | ||
) |
Sets the visibility of the specified undo mark
Created in NX3.0.0.
License requirements : None
markId | ID of mark |
markName | Name of the mark. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
visibility | the new visibility |
NXOpen::SubdivisionTaskEnvironment* NXOpen::Session::SubdivisionTaskEnvironment | ( | ) |
Returns the NXOpen::SubdivisionTaskEnvironment belonging to this session
Created in NX9.0.0.
NXOpen::Tooling::ToolingSession* NXOpen::Session::ToolingSession | ( | ) |
Returns the NXOpen::Tooling::ToolingSession belonging to this session
Created in NX8.0.0.
NXOpen::Session::TransientPartPolicy NXOpen::Session::TransientPartPersistencePolicy | ( | ) |
Returns the persistence policy for transient parts in the session
Created in NX4.0.0.
License requirements : None
void NXOpen::Session::UndoLastNVisibleMarks | ( | int | n, |
bool * | marksRecycled, | ||
bool * | undoUnavailable | ||
) |
Undo to a specified number of visible marks starting with the most recently created visible mark.
If the number is less than 1, then all visible marks are undone. If the number is greater than the total number of visible marks, then all visible marks will be undone. Marks undone via this routine may be redone via Redo if the operations undone permit it.
Created in NX3.0.0.
License requirements : None
n | Number of visible marks to undo |
marksRecycled | True if undo succeeded but no marks remain. This may indicate previous marks have been recycled. |
undoUnavailable | True if not all requested marks were undone and the application has locked the undo system. |
void NXOpen::Session::UndoToLastVisibleMark | ( | ) |
Undo to last visible mark.
This will not delete the undo mark. Use UndoLastNVisibleMarks to delete the undo mark also.
Created in NX3.0.0.
License requirements : None
void NXOpen::Session::UndoToMark | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Undo to the specified mark
Created in NX3.0.0.
License requirements : None
markId | ID of mark to undo to |
markName | Name of mark to undo to. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::UndoToMark | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Undo to the specified mark
Created in NX3.0.0.
License requirements : None
markId | ID of mark to undo to |
markName | Name of mark to undo to. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::UndoToMarkWithStatus | ( | NXOpen::Session::UndoMarkId | markId, |
const NXString & | markName | ||
) |
Undo to the specified mark and output status to status bar.
Created in NX3.0.0.
License requirements : None
markId | ID of mark to undo to |
markName | Name of mark to undo to. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Session::UndoToMarkWithStatus | ( | NXOpen::Session::UndoMarkId | markId, |
const char * | markName | ||
) |
Undo to the specified mark and output status to status bar.
Created in NX3.0.0.
License requirements : None
markId | ID of mark to undo to |
markName | Name of mark to undo to. Used only if mark_id not found NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::Update* NXOpen::Session::UpdateManager | ( | ) |
Returns the NXOpen::Update belonging to this session
Created in NX3.0.0.
NXOpen::UserDefinedObjects::UserDefinedClassManager* NXOpen::Session::UserDefinedClassManager | ( | ) |
Returns the NXOpen::UserDefinedObjects::UserDefinedClassManager belonging to this session
Created in NX3.0.0.
NXOpen::Features::UserDefinedFeatureClassManager* NXOpen::Session::UserDefinedFeatureClassManager | ( | ) |
Returns the NXOpen::Features::UserDefinedFeatureClassManager belonging to this session
Created in NX8.0.0.
NXOpen::Validate::ValidationManager* NXOpen::Session::ValidationManager | ( | ) |
Returns the NXOpen::Validate::ValidationManager belonging to this session
Created in NX7.5.0.
NXOpen::VisualReporting::VisualReportManager* NXOpen::Session::VisualReportManager | ( | ) |
Returns the NXOpen::VisualReporting::VisualReportManager instance belonging to this session
Created in NX7.0.0.
NXOpen::Weld::WeldCpdUtils* NXOpen::Session::WeldCpdUtils | ( | ) |
Returns the NXOpen::Weld::WeldCpdUtils instance belonging to this session
Created in NX9.0.0.
NXOpen::Weld::CustomManager* NXOpen::Session::WeldCustomManager | ( | ) |
Returns the NXOpen::Weld::CustomManager belonging to this session
Created in NX8.0.0.
NXOpen::Validate::XmlComparator* NXOpen::Session::XmlComparator | ( | ) |
Returns the NXOpen::Validate::XmlComparator instance belonging to this session
Created in NX6.0.2.
NXOpen::CAE::Xyplot::XYPlotManager* NXOpen::Session::XYPlotManager | ( | ) |
Returns the NXOpen::CAE::Xyplot::XYPlotManager belonging to this session
Created in NX7.5.0.