class ref name: list_dbag
category-group: dbag
layer: 3

member functions (primary)

list_dbag_o()
SIGNATURE: dbag_o ()
SYNOPSIS:
creates a a new dbag object, completely devoid of contents. The object has no internal structure - no string has been given to it to define any data structure. This "function" cannot be called directly, since this class is abstract (this is called only via instantiation of sub-classes).
 

list_dbag_o(list_dbag_o)
SIGNATURE: dbag_o (const dbag_o &that)
SYNOPSIS:
copy constructor: creates a a new databag object which is an exact image of the copied databag object "that". This constructor ["function"] cannot be called directly, since this class is abstract (this is called only via instantiation of sub-classes).
 

operator = (list_dbag_o)
SIGNATURE: const dbag_o &operator = (const dbag_o &rhs)
SYNOPSIS:
copies exactly the RHS object ("rhs"), to the existing databag object instance.
Note that although this operation can be explicitly done, doing so is strange. This operator is intended to be called only via sub-classes.
RETURNS: a reference to the current databag object
 

destructor
SIGNATURE: ~dbag_o ()
SYNOPSIS:
virtual destructor. The databag instance is wiped out and all contents are reinitialized to the at-construction state. This is [almost?] always called exclusively as part of the destruction process of a sub-class instance.
 

list_dbag_o(<args>)
SIGNATURE: dbag_o (const string_o &s)
SYNOPSIS:
create a new databag object. This constructor does nothing more than set the name of the databag, to that of "s". This constructor cannot be called directly, but only through the construction process of subclasses.
PARAMETERS

  • s: the name to be assigned to the databag. the contents of 's' should be a simple "name" - characters consisting of letters and or numbers (and possibly embedded underscores - '_').
  •