|
Classes | |
| class | AcisJournal |
| Contains data and methods related to journaling operation. More... | |
Functions | |
| outcome | api_end_journal (AcisOptions *ao) |
| Sets the status flag off journalizing and finishes the snapshot journaling mechanism. | |
| outcome | api_get_journal (AcisOptions *ao, AcisJournal *&aj) |
Gets a reference to the AcisJournal contained in AcisOptions. | |
| outcome | api_pause_journal (AcisOptions *ao) |
| Sets the status flag for journalizing to off, disabling the snapshot journal mechanism. | |
| outcome | api_resume_journal (AcisOptions *ao) |
| Sets the status flag for journalizing to on, enabling the snapshot journal mechanism. | |
| outcome | api_set_journal (AcisOptions *ao, AcisJournal &aj) |
Copies the AcisJournal object to AcisOptions. | |
| outcome | api_set_journal_name (AcisJournal *aj, char *name) |
| Sets the snapshot journal file name. | |
| outcome | api_set_journal_name (AcisOptions *ao, char *name) |
| Sets the snapshot journal file name. | |
| outcome | api_start_journal (AcisOptions *ao) |
| Sets the status flag for journalizing to on and initializes journal. | |
| outcome api_end_journal | ( | AcisOptions * | ao | ) |
Sets the status flag off journalizing and finishes the snapshot journaling mechanism.
Role: Sets the status flag to off and writes down the script footer.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options such as version, journal. |
include <acis_journal.hxx>
| outcome api_get_journal | ( | AcisOptions * | ao, | |
| AcisJournal *& | aj | |||
| ) |
Gets a reference to the AcisJournal contained in AcisOptions.
Role: Gets a reference to the AcisJournal object contained in the AcisOptionsInternal data member.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options. | |
| aj | output reference to acis journal. |
include <acis_journal.hxx>
| outcome api_pause_journal | ( | AcisOptions * | ao | ) |
Sets the status flag for journalizing to off, disabling the snapshot journal mechanism.
Role: Sets the status flag to off to disable journalizing.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options. |
include <acis_journal.hxx>
| outcome api_resume_journal | ( | AcisOptions * | ao | ) |
Sets the status flag for journalizing to on, enabling the snapshot journal mechanism.
Role: Sets the status flag to on to enable journalizing.
Errors: If this is used before start. The header will not be written and some functions will fail to journalize.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options. |
include <acis_journal.hxx>
| outcome api_set_journal | ( | AcisOptions * | ao, | |
| AcisJournal & | aj | |||
| ) |
Copies the AcisJournal object to AcisOptions.
Role: Takes the AcisJournal object and copies it into the data member contained in the AcisOptionsInternal data member.
Limitations: The journals object is true copied, it is independent from the one contained in the AcisOptions object.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options. | |
| aj | acis journal to be copied. |
include <acis_journal.hxx>
| outcome api_set_journal_name | ( | AcisJournal * | aj, | |
| char * | name | |||
| ) |
Sets the snapshot journal file name.
Role: Sets the file name for the snapshot journal. The extension name is not needed.
Limitations: If a name other than AcisJour is set, then the new name would be used always. In this case, instead of serializing the output name (AcisJour_x, scm, x = 0...n), it would create always the same file (e.g. My_name.scm). This can be really useful because it will not create a large number of files if the journal is implemented in a function that is called many times and it is desired to keep only the last call (e.g. when an error occurs).
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| aj | acis journal. | |
| name | journal file name. |
include <acis_journal.hxx>
| outcome api_set_journal_name | ( | AcisOptions * | ao, | |
| char * | name | |||
| ) |
Sets the snapshot journal file name.
Role: Sets the file name for the snapshot journal. The extension name is not needed.
Limitations: If a name other than AcisJour is set, then the new name would be used always. In this case, instead of serializing the output name (AcisJour_x, scm, x = 0...n), it would create always the same file (e.g. My_name.scm). This can be really useful because it will not create a large number of files if the journal is implemented in a function that is called many times and it is desired to keep only the last call (e.g. when an error occurs).
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options. | |
| name | journal file name. |
include <acis_journal.hxx>
| outcome api_start_journal | ( | AcisOptions * | ao | ) |
Sets the status flag for journalizing to on and initializes journal.
Role: Sets the status flag on to enable journalizing. It creates the journal file and writes down the header. It also generates the SAT file name and sets the file name counters properly.
Errors: Starting again an already enabled journal may cause erasing previously saved files or leaving incomplete journaled files.
Effect: System routine
Journal: Not Available
Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler
| ao | acis options such as journal, version. |
include <acis_journal.hxx>