All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SPAkern Class AcisOptions

SPAbase.ACIS_OBJECT
  |
  +---AcisOptions

Usage: you must use this class as is. You should never derive it.

public class AcisOptions

Implements an 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. 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 and Destructor Index

o AcisOptions(): C++ allocation constructor requests memory for this object but does not populate it.
o AcisOptions(AcisJournal&): C++ allocation constructor requests memory for this object and populates the value of AcisJournal alone with the value of the passed argument.
o AcisOptions(AcisJournal&,AcisVersion const&): 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.
o AcisOptions(AcisOptions*): C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument.
o AcisOptions(AcisVersion const&): C++ allocation constructor requests memory for this object and populates the value of AcisVersion alone with the value of the passed argument.
o ~AcisOptions(): C++ destructor for AcisOptions which deallocates memory.

Method Index

o get_journal(): This method returns the AcisJournal value.
o get_version(): This method returns the AcisVersion value.
o journal_on(): This method returns TRUE if the journal is enabled and the specified component is set to be journaled, Otherwise it returns FALSE.
o operator=(AcisOptions&): This method verifies if the existing AcisOptions object is the same as the object passed as the argument.
o set_journal(AcisJournal&): This method sets the value of AcisJournal to the value of the passed AcisJournal object.
o set_version(AcisVersion const&): This method sets the value of AcisVersion of the AcisOptions object to the value of the passed AcisVersion object.

Constructor and Destructor

o AcisOptions

public AcisOptions(

)

C++ allocation constructor requests memory for this object but does not populate it.

o AcisOptions

public 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.

Parameters:

journal: journal.

o AcisOptions

public 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.

Parameters:

journal: journal.
version: version.

o AcisOptions

public 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.

Parameters:

ao: Acis Options.

o AcisOptions

public 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.

Parameters:

version: version.

o ~AcisOptions

public virtual ~AcisOptions(

)

C++ destructor for AcisOptions which deallocates memory.

Methods

o get_journal

public virtual AcisJournal& get_journal(

)

This method returns the AcisJournal value.

o get_version

public virtual AcisVersion& get_version(

)

This method returns the AcisVersion value.

o journal_on

public 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.

o operator=

public virtual AcisOptions& operator=( const AcisOptions& ao)

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.

Parameters:

ao: acis options.

o set_journal

public virtual void set_journal( AcisJournal& journalInfo)

This method sets the value of AcisJournal to the value of the passed AcisJournal object.

Parameters:

journalInfo: journal.

o set_version

public 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.

Parameters:

version: version.

This object is included in the file: acis_options.hxx