|
NX Open C++ Reference Guide
|
Represents the JournalManager which is used to query data about journals when recording and replaying journal files. More...
Public Member Functions | |
| bool | IsJournalRecording () |
| Returns the flag indicating if a Journal is recording. More... | |
| NXOpen::Preferences::SessionUserInterface::JournalLanguageType | JournalLanguage () |
| Returns. More... | |
| bool | PauseJournal () |
| Returns the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal. More... | |
| void | SetPauseJournal (bool isJournalRunning) |
| Sets the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Represents the JournalManager which is used to query data about journals when recording and replaying journal files.
The language NX is setup to, or currently recording can be determined from NXOpen::Preferences::SessionUserInterface::JournalLanguage .
To obtain an instance of this class, refer to NXOpen::Session
Created in NX11.0.0.
| bool NXOpen::JournalManager::IsJournalRecording | ( | ) |
Returns the flag indicating if a Journal is recording.
If true, a journal is recording.
Created in NX11.0.0.
License requirements : None
| NXOpen::Preferences::SessionUserInterface::JournalLanguageType NXOpen::JournalManager::JournalLanguage | ( | ) |
Returns.
the language the journal will be recored in.
This is a convenience querry, as this will return the same value as NXOpen::Preferences::SessionUserInterface::JournalLanguage
Created in NX11.0.0.
License requirements : None
| bool NXOpen::JournalManager::PauseJournal | ( | ) |
Returns the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal.
When this method is called from journal file playing, the pause will end automatically after it it is done replaying. This is true if the journal is run inside of NX using the Play Journal functionality or using the methods NXOpen.JournalManager.PlayDotNetJournal or NXOpen.JournalManager.PlayPythonJournal called from the executing journal. In other words, if you start recording a journal, and then play a journal (through Play Journal Dialog or method call) which calls this method. The journal will be only paused while it is playing, and then once that journal is done playing journaling will resume.
When this method is called from a NXOpen DLL it will persist after DLL is run or has returned control to NX for those programs that are not immediately unloaded after running. This can have an impact on Redo if this DLL is run outside of Journal record scenario.
Created in NX11.0.0.
License requirements : None
| void NXOpen::JournalManager::SetPauseJournal | ( | bool | isJournalRunning | ) |
Sets the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal.
When this method is called from journal file playing, the pause will end automatically after it it is done replaying. This is true if the journal is run inside of NX using the Play Journal functionality or using the methods NXOpen.JournalManager.PlayDotNetJournal or NXOpen.JournalManager.PlayPythonJournal called from the executing journal. In other words, if you start recording a journal, and then play a journal (through Play Journal Dialog or method call) which calls this method. The journal will be only paused while it is playing, and then once that journal is done playing journaling will resume.
When this method is called from a NXOpen DLL it will persist after DLL is run or has returned control to NX for those programs that are not immediately unloaded after running. This can have an impact on Redo if this DLL is run outside of Journal record scenario.
Created in NX11.0.0.
License requirements : None
| isJournalRunning | isjournalrunning |
| tag_t NXOpen::JournalManager::Tag | ( | ) | const |
Returns the tag of this object.