#include <acis_journal.hxx>
Public Member Functions | |
| AcisJournal (const AcisJournal &aj) | |
| Copy constructor. | |
| AcisJournal () | |
| Default constructor. | |
| void | end_journaling () |
This method is used to end the journaling operation that was started using start_journaling method. | |
| const char * | get_file_name () const |
| This method is used to retrieve the scheme and SAT file name stored in this object. | |
| logical | get_status () const |
| This method returns the status of the journaling operation. | |
| void | set_file_name (char *name) |
| This method is used to set the filename for scheme and sat files. | |
| void | set_status (logical st) |
| This method is used to set the status of the journaling operation to on or off. | |
| void | start_journaling () |
| This method is used to start journaling operation. | |
| virtual | ~AcisJournal () |
| Destructor releases the memory allocated for this object when this object goes out of scope. | |
Role: AcisJournal object provides methods to get or set scheme and SAT filenames for journaling. It also provides methods to start, end, pause and resume journaling operation. However the direct use of the methods is discouraged and the user is advised to use the equivalent API calls like api_set_journal_name, api_start_journal etc. instead.
| AcisJournal::AcisJournal | ( | ) |
Default constructor.
Role: Instantiates an AcisJournal object with SAT and scheme file names set to ACISJour.
| virtual AcisJournal::~AcisJournal | ( | ) | [virtual] |
Destructor releases the memory allocated for this object when this object goes out of scope.
| AcisJournal::AcisJournal | ( | const AcisJournal & | aj | ) |
Copy constructor.
Role: Instantiates an AcisJournal object and copies the values from the AcisJournal object passed as an argument.
| aj | journal. |
| void AcisJournal::end_journaling | ( | ) |
This method is used to end the journaling operation that was started using start_journaling method.
Role: It adds the scheme file footer information and closes the SAT and scheme files. The user is advised to use api_end_journal instead.
| const char* AcisJournal::get_file_name | ( | ) | const |
This method is used to retrieve the scheme and SAT file name stored in this object.
| logical AcisJournal::get_status | ( | ) | const |
This method returns the status of the journaling operation.
Role: A value of TRUE indicates that the journaling operation is on. A value of FALSE indicates that the journaling operation is off.
| void AcisJournal::set_file_name | ( | char * | name | ) |
This method is used to set the filename for scheme and sat files.
Role: The user is advised to use api_set_journal_name instead.
| name | journal file name. |
| void AcisJournal::set_status | ( | logical | st | ) |
This method is used to set the status of the journaling operation to on or off.
Role: A value of FALSE is used to pause the journaling operation. A value of TRUE is used to resume the journaling operation that was paused. The user is advised to use api_pause_journal and api_resume_journal instead.
| st | journaling on or off. |
| void AcisJournal::start_journaling | ( | ) |
This method is used to start journaling operation.
Role: It opens the SAT and scheme files and adds the header information. It stores the file handler for subsequent journaling by other APIs. The user is advised to use api_start_journal instead.