AcisOptions class.
More...
#include <acis_options.hxx>
Public Member Functions | |
| AcisOptions (AcisVersion const &version) | |
C++ allocation constructor requests memory for this object and populates the value of AcisVersion alone with the value of the passed argument. | |
| AcisOptions (AcisJournal &journal, AcisVersion const &version) | |
C++ allocation constructor requests memory for this object and populates the value of AcisJournal as well as AcisVersion with the corresponding values in the passed arguments. | |
| AcisOptions (AcisJournal &journal) | |
C++ allocation constructor requests memory for this object and populates the value of AcisJournal alone with the value of the passed argument. | |
| AcisOptions (const AcisOptions *ao) | |
| C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument. | |
| AcisOptions () | |
| C++ allocation constructor requests memory for this object but does not populate it. | |
| virtual AcisJournal & | get_journal () |
This method returns the AcisJournal value. | |
| virtual AcisVersion & | get_version () |
This method returns the AcisVersion value. | |
| logical | journal_on () |
This method returns TRUE if the journal is enabled and the specified component is set to be journaled, Otherwise it returns FALSE. | |
| virtual AcisOptions & | operator= (const AcisOptions &ao) |
This method verifies if the existing AcisOptions object is the same as the object passed as the argument. | |
| virtual void | set_journal (AcisJournal &journalInfo) |
This method sets the value of AcisJournal to the value of the passed AcisJournal object. | |
| virtual void | set_version (AcisVersion const &version) |
This method sets the value of AcisVersion of the AcisOptions object to the value of the passed AcisVersion object. | |
| virtual | ~AcisOptions () |
C++ destructor for AcisOptions which deallocates memory. | |
AcisOptions class.
Role: The AcisOptions class is designed to act as a simple class that holds options which are to be passed to every API function. The options include information like Version and Journal.
| AcisOptions::AcisOptions | ( | ) |
C++ allocation constructor requests memory for this object but does not populate it.
| AcisOptions::AcisOptions | ( | const AcisOptions * | ao | ) |
C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument.
| ao | Acis Options. |
| AcisOptions::AcisOptions | ( | AcisJournal & | journal | ) |
C++ allocation constructor requests memory for this object and populates the value of AcisJournal alone with the value of the passed argument.
| journal | journal. |
| AcisOptions::AcisOptions | ( | AcisJournal & | journal, | |
| AcisVersion const & | version | |||
| ) |
C++ allocation constructor requests memory for this object and populates the value of AcisJournal as well as AcisVersion with the corresponding values in the passed arguments.
| journal | journal. | |
| version | version. |
| AcisOptions::AcisOptions | ( | AcisVersion const & | version | ) |
C++ allocation constructor requests memory for this object and populates the value of AcisVersion alone with the value of the passed argument.
| version | version. |
| virtual AcisOptions::~AcisOptions | ( | ) | [virtual] |
C++ destructor for AcisOptions which deallocates memory.
| virtual AcisJournal& AcisOptions::get_journal | ( | ) | [virtual] |
This method returns the AcisJournal value.
| virtual AcisVersion& AcisOptions::get_version | ( | ) | [virtual] |
This method returns the AcisVersion value.
| logical AcisOptions::journal_on | ( | ) |
This method returns TRUE if the journal is enabled and the specified component is set to be journaled, Otherwise it returns FALSE.
| virtual AcisOptions& AcisOptions::operator= | ( | const AcisOptions & | ao | ) | [virtual] |
This method verifies if the existing AcisOptions object is the same as the object passed as the argument.
Role: In case, both of them are same, it returns the existing AcisOptions object. If they are not the same, it replaces the existing AcisOptions object with the passed object and returns the same.
| ao | acis options. |
| virtual void AcisOptions::set_journal | ( | AcisJournal & | journalInfo | ) | [virtual] |
This method sets the value of AcisJournal to the value of the passed AcisJournal object.
| journalInfo | journal. |
| virtual void AcisOptions::set_version | ( | AcisVersion const & | version | ) | [virtual] |
This method sets the value of AcisVersion of the AcisOptions object to the value of the passed AcisVersion object.
| version | version. |