class DoomWriter

(Return to index)

Encapsulates writing to the DOOM data base.

This class constructs a DOOM ``object'' to be writtin to the DOOM data base and writes it out automatically when the DoomWriter goes out of scope.

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

Synopsis (including inherited members):

• Public members:
  • DoomWriter () ;
  • DoomWriter (const string&) ;
  • DoomWriter (const string&,const int[]) ;
  • ~DoomWriter () ;
  • void putReal (int,double) ;
  • void putInt (int,int) ;
  • void putString (int,const string&) ;
  • void setObjectName (const string&) ;
  • void setObjectName (const string&,const int[]) ;
  • void setBaseName (const string&) ;
  • void setParentName (const string&) ;
  • void setTypeName (const string&) ;

Documentation:

• Public members:

  DoomWriter () ;

  Default constructor.
  Constructs an empty writer object. An object constructed with the default constructor can only be written if its name is set before the destructor is called.

  DoomWriter (const string&) ;

  Constructor.
  Construct an empty writer object for the MAD Object name.

  DoomWriter (const string&,const int[]) ;

  Constructor.
  Construct an empty writer object for the MAD Object name. Like DoomWriter(name), but use keyList to further identify the object.

  void putInt (int,int) ;

  Store real value.
  Identified by index.

  void putReal (int,double) ;

  Store real value.
  Identified by index.

  void putString (int,const string&) ;

  Store real value.
  Identified by index.

  void setBaseName (const string&) ;

  Set base name.
  This is the name of the MAD exemplar object from which the object is ultimately derived.

  void setObjectName (const string&) ;

  Set object name.
  This is the name of the MAD object itself.

  void setObjectName (const string&,const int[]) ;

  Set object name.
  Like setObjectName(name), but use keyList to further identify the object.

  void setParentName (const string&) ;

  Set parent name.
  This is the name of the MAD class object from which the object is derived directly.

  void setTypeName (const string&) ;

  Set type name.
  This is the DOOM object type like "ELEMENT", "ACTION", etc.

  ~DoomWriter () ;

  Destructor.
  Save the object to the DOOM data base, if its name is set.