|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents the JournalManager which is used to query data about journals when recording and replaying journal files. More...
Public Member Functions | |
| void | InsertComment (const NXString &comment) |
| Inserts string as a comment into the journal. More... | |
| void | InsertComment (const char *comment) |
| Inserts string as a comment into the journal. More... | |
| void | InsertUserDefinedCode (const NXString &userDefinedCode) |
| Inserts the passed in string into a journal. More... | |
| void | InsertUserDefinedCode (const char *userDefinedCode) |
| Inserts the passed in string into a journal. More... | |
| bool | IsJournalRecording () |
| Returns the flag indicating if a Journal is recording. More... | |
| bool | IsJournalRunning () |
| Returns the flag indicating if a Journal is replaying inside of NX. 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... | |
| bool | PauseJournalingOfBlockStylerCalls () |
| Returns the flag to indicate if Blockstyler journal calls should be paused. More... | |
| void | RecordJournal (const NXString &filename) |
| Start recording a journal file. More... | |
| void | RecordJournal (const char *filename) |
| Start recording a journal file. More... | |
| void | SetPauseJournal (bool isJournalRunning) |
| Sets the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal. More... | |
| void | SetPauseJournalingOfBlockStylerCalls (bool pauseBlockStylerCalls) |
| Sets the flag to indicate if Blockstyler journal calls should be paused. More... | |
| void | StopRecordingJournal () |
| Stops Recording a journal file. 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.
| void NXOpen::JournalManager::InsertComment | ( | const NXString & | comment | ) |
Inserts string as a comment into the journal.
The comment with appropriate markups for the language being recorded so it will be a comment. If this is called when not journaling, this method does nothing.
Created in NX11.0.0.
License requirements : None
| comment | comment to be inserted into the journal |
| void NXOpen::JournalManager::InsertComment | ( | const char * | comment | ) |
Inserts string as a comment into the journal.
The comment with appropriate markups for the language being recorded so it will be a comment. If this is called when not journaling, this method does nothing.
Created in NX11.0.0.
License requirements : None
| comment | comment to be inserted into the journal |
| void NXOpen::JournalManager::InsertUserDefinedCode | ( | const NXString & | userDefinedCode | ) |
Inserts the passed in string into a journal.
If this is called when not journaling, this method does nothing.
Created in NX11.0.0.
License requirements : None
| userDefinedCode | user defined code to be inserted into the journal |
| void NXOpen::JournalManager::InsertUserDefinedCode | ( | const char * | userDefinedCode | ) |
Inserts the passed in string into a journal.
If this is called when not journaling, this method does nothing.
Created in NX11.0.0.
License requirements : None
| userDefinedCode | user defined code to be inserted into the journal |
| 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
| bool NXOpen::JournalManager::IsJournalRunning | ( | ) |
Returns the flag indicating if a Journal is replaying inside of NX.
If true, a journal is running. This will only return true if we are replaying a journal using the Play Journal dialog inside a NX interactive session. This will be limited to only VB, C#, and Python journals replaying.
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
| bool NXOpen::JournalManager::PauseJournalingOfBlockStylerCalls | ( | ) |
Returns the flag to indicate if Blockstyler journal calls should be paused.
If true BlockStyler calls will not be recorded to the 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::RecordJournal | ( | const NXString & | filename | ) |
Start recording a journal file.
This will record a journal file in the language specified by NXOpen::Preferences::SessionUserInterface::SetJournalLanguage . The proper exentsion will be added based upon the preference.
An error will be thrown if a journal is already recording.
Created in NX11.0.0.
License requirements : dotnet_author (".NET API Author")
| filename | path to record journal file. The extension will be added automatically based upon the preferences. |
| void NXOpen::JournalManager::RecordJournal | ( | const char * | filename | ) |
Start recording a journal file.
This will record a journal file in the language specified by NXOpen::Preferences::SessionUserInterface::SetJournalLanguage . The proper exentsion will be added based upon the preference.
An error will be thrown if a journal is already recording.
Created in NX11.0.0.
License requirements : dotnet_author (".NET API Author")
| filename | path to record journal file. The extension will be added automatically based upon the preferences. |
| 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 |
| void NXOpen::JournalManager::SetPauseJournalingOfBlockStylerCalls | ( | bool | pauseBlockStylerCalls | ) |
Sets the flag to indicate if Blockstyler journal calls should be paused.
If true BlockStyler calls will not be recorded to the 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
| pauseBlockStylerCalls | pauseblockstylercalls |
| void NXOpen::JournalManager::StopRecordingJournal | ( | ) |
Stops Recording a journal file.
An error will be thrown if this is called and NX is not currently recording.
Created in NX11.0.0.
License requirements : dotnet_author (".NET API Author")
| tag_t NXOpen::JournalManager::Tag | ( | ) | const |
Returns the tag of this object.
