|
Purpose:
|
Implements an
AcisOptions class.
|
|
|
Derivation:
|
AcisOptions : ACIS_OBJECT : -
|
|
|
Filename:
|
kern/kernel/kernapi/api/acis_options.hxx
|
|
|
Description:
|
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. This class is intended to be the base class for option classes particular to every component, such as
sweep_options and
skin_options. These derivated classes contain optional parameters that the API takes.
|
|
|
Constructor:
|
public: AcisOptions::AcisOptions
();
|
|
|
C++ allocation constructor requests memory for this object but does not populate it.
|
|
|
|
|
|
|
public: 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.
|
|
|
|
|
|
|
public: AcisOptions::AcisOptions
(
|
|
|
AcisJournal& journal,
|
|
// journal
|
|
|
AcisVersion const& version
|
// 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.
|
|
|
|
|
|
|
public: AcisOptions::AcisOptions
(
|
|
|
AcisVersion const& version
|
// version
|
|
|
);
|
|
|
C++ allocation constructor requests memory for this object and populates the value of AcisVersion alone with the value of the passed argument.
|
|
|
|
|
|
|
public: AcisOptions::AcisOptions
(
|
|
|
const AcisOptions* ao
|
// acis options
|
|
|
);
|
|
|
C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument.
|
|
|
|
|
|
Destructor:
|
public: virtual AcisOptions::~AcisOptions
();
|
|
|
C++ destructor for
AcisOptions which deallocates memory.
|
|
|
|
|
Methods:
|
public: virtual AcisJournal& AcisOptions::get_journal
();
|
|
|
This method returns the
AcisJournal value.
|
|
|
|
|
|
|
public: virtual AcisVersion& AcisOptions::get_version
();
|
|
|
This method returns the
AcisVersion value.
|
|
|
|
|
|
|
public: logical AcisOptions::journal_on
();
|
|
|
This method returns TRUE if the journal is enabled and the specified component is set to be journaled. It returns FALSE otherwise.
|
|
|
|
|
|
|
public: virtual AcisOptions& AcisOptions::operator=
(
|
|
|
const AcisOptions&
|
// acis options
|
|
|
);
|
|
|
This method verifies if the existing
AcisOptions object is the same as the object passed as the argument. 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.
|
|
|
|
|
|
|
public: virtual void AcisOptions::set_journal
(
|
|
|
AcisJournal& journalInfo
|
// journal
|
|
|
);
|
|
|
This method sets the value of
AcisJournal to the value of the passed
AcisJournal object.
|
|
|
|
|
|
|
public: virtual void AcisOptions::set_version
(
|
|
|
AcisVersion const& version
|
// version
|
|
|
);
|
|
|
This method sets the value of
AcisVersion of the
AcisOptions object to the value of the passed
AcisVersion object.
|
|
|
|
|
|
Related Fncs:
|
api_set_acis_options, api_set_version
|