class DoomDB

(Return to index)

Encapsulates the DOOM data base.

Objects are read from the data base using a DoomReader object, and written using a DoomWriter object. These objects encapsulate Hans Grote's ``object'' structure. Their constructors and destructors handle the necessary transmission from and to the data base.

Type:	Instantiable
Include file:	./AbstractObjects/DoomDB.hh

Synopsis (including inherited members):

• Public members:
  • DoomDB () ;
  • ~DoomDB () ;
  • static int getAttributeIndex (const string&) ;
  • void firstOpen (const char*) ;
  • void reOpen () ;
  • void shut () ;
  • void setDebug (int) ;
  • void setUpdate (bool) ;
  • Object* readObject (const string&) ;
  • void writeObject (Object*) ;
  • bool readAlign (const string&,int,Euclid3D&) ;
  • void writeAlign (const string&,int,const Euclid3D&) ;
  • static bool readField (const string&,int,double,const BMultipoleField&,BMultipoleField&) ;
  • static void writeField (const string&,int,double,const BMultipoleField&,const BMultipoleField&) ;
  • static void setEnvironment (const char[],const string&) ;

Documentation:

• Public members:

  DoomDB () ;

  Constructor.
  Initialise the data base, but do not open it.

  void firstOpen (const char*) ;

  Open data base (first time) identified by file name dbName.

  static int getAttributeIndex (const string&) ;

  Find DOOM index for element attribute.
  Find the internal index for the element attribute identified by name.

  void reOpen () ;

  Re-open data base which was already open.

  bool readAlign (const string&,int,Euclid3D&) ;

  Read misalignment.

  Object* readObject (const string&) ;

  Read object.
  Identified by the name name.

  void setDebug (int) ;

  Set the debug flag.
  See the DOOM documentation for details.

  static void setEnvironment (const char[],const string&) ;

  Set DOOM environment variable.
  Call doom_setenv(name, value). See the DOOM documentation for details.

  void setUpdate (bool) ;

  Set update flag.
  Called when an object is created or modified, to force writing all modified objects to the data base when MAD is shut down.

  void shut () ;

  Close the data base.

  void writeAlign (const string&,int,const Euclid3D&) ;

  Write misalignment.

  void writeObject (Object*) ;

  Write object.

  ~DoomDB () ;

  Destructor.
  Do nothing.