#include <ssCommonEnviroment.h>
Inheritance diagram for ssCommonEnviroment:
Public Member Functions | |
| virtual bool | Hup () |
| Re parse the input file to update the state of this object with that file. | |
| const GoNogo & | State () const |
| Give the major state of this object. | |
| const string | ContextFile () const |
| Give the context file used by this parser. | |
| const string & | DatasetBase () const |
| Give the argument to the DatasetBase variable. | |
| int | DefaultThreeDXSize () |
| Give the argument to the DefaultThreeDXSize variable. | |
| int | DefaultThreeDYSize () |
| Give the argument to the DefaultThreeDYSize variable. | |
| const string & | InstrumentType () const |
| Give the name Multibeam Instrument type to use. | |
| int | DefaultPingsPerSwath () const |
| Give the number of pings per swath. | |
| int | DefaultSwathsToFilter () const |
| Give the number of swaths to filter. | |
Static Public Member Functions | |
| static ssCommonEnviroment * | New () |
| Give an object within the "default" context. | |
| static ssCommonEnviroment * | New (const string &context) |
| Give an object within a context. | |
Protected Member Functions | |
| ssCommonEnviroment () | |
| Ctor. | |
| ssCommonEnviroment (const string &context) | |
| Ctor. | |
| ~ssCommonEnviroment () | |
| Dtor. | |
Objects of this class are a Singleton Factories. There will not be more than one object per category. These Singleton objects will be avaliable system wide.
Definition at line 25 of file ssCommonEnviroment.h.
| ssCommonEnviroment::ssCommonEnviroment | ( | ) | [protected] |
Ctor.
| ssCommonEnviroment::ssCommonEnviroment | ( | const string & | context | ) | [protected] |
Ctor.
Construct a new enviroment. This is not avaliable outside this class. Use the New() method to get an object of this type.
| context | The context of the enviroment. The main purpose of this parameter is to specify a system wide context based upon the name of the system or program. However, its is possible to have more than one CommonEnviroments, each with its own unique context, extant within in on system or program. The practical effect of this parameter is to cause this object to be constructed on a file named ~/.<context>/CommonEnviroment.rc. |
| ssCommonEnviroment::~ssCommonEnviroment | ( | ) | [protected] |
Dtor.
| static ssCommonEnviroment* ssCommonEnviroment::New | ( | ) | [static] |
Give an object within the "default" context.
This object will be an instance of the "master" object having the context. So all objects having a certain context will be equal to each other, in every way, at all times.
The file used in this instance is ~/.SwathSonar/CommonEnviroment.rc. That is the context is "CommonEnviroment".
Reimplemented from ssEnviroment.
| static ssCommonEnviroment* ssCommonEnviroment::New | ( | const string & | context | ) | [static] |
Give an object within a context.
This object will be an instance of a "master" object having the context. So all objects having a certain context will be equal to each other, in every way, at all times.
| context | The context of the enviroment. The main purpose of this parameter is to specify a system wide context based upon the name of the system or program. However, its is possible to have more than one CommonEnviroments, each with its own unique context, extant within in on system or program. The practical effect of this parameter is to cause this object to be constructed on a file named ~/.SwathSonar/<context>.rc. |
| virtual bool ssCommonEnviroment::Hup | ( | ) | [virtual] |
Re parse the input file to update the state of this object with that file.
Reimplemented from ssEnviroment.
| const GoNogo& ssCommonEnviroment::State | ( | ) | const |
Give the major state of this object.
| const string ssCommonEnviroment::ContextFile | ( | ) | const |
Give the context file used by this parser.
| const string& ssCommonEnviroment::DatasetBase | ( | ) | const |
Give the argument to the DatasetBase variable.
| int ssCommonEnviroment::DefaultThreeDXSize | ( | ) |
Give the argument to the DefaultThreeDXSize variable.
| int ssCommonEnviroment::DefaultThreeDYSize | ( | ) |
Give the argument to the DefaultThreeDYSize variable.
| const string& ssCommonEnviroment::InstrumentType | ( | ) | const |
Give the name Multibeam Instrument type to use.
| int ssCommonEnviroment::DefaultPingsPerSwath | ( | ) | const |
Give the number of pings per swath.
| int ssCommonEnviroment::DefaultSwathsToFilter | ( | ) | const |
Give the number of swaths to filter.
