Itzam/C++

Main Index

Created by Scott Robert Ladd at Coyote Gulch Productions.

itzam::database_object

itzam::database_object Class Reference

Common elements of all database types. More...

#include <itzam_common.h>

Inheritance diagram for itzam::database_object:

List of all members.

Public Member Functions

database_object (const string &name, itzam_file_lock_mode lock_mode)
Constructor.
database_object (const database_object &source)
Copy constructor.
database_object & operator= (const database_object &source)
Assignment operator.
database_state get_state () const
Return the state value for a database object.
string get_name () const
Return the name.
itzam_file_lock_mode get_lock_mode () const
Return the file-locking mode.
bool is_okay () const
Is this database "okay?".
bool is_broken () const
Is this database broken?
bool is_open () const
Is this database open?
bool is_closed () const
Is this database closed?

Protected Attributes

database_state m_state
The current database state.
itzam_file_lock_mode m_file_lock_mode
File-locking mode.
string m_name
Name of file containing.

Detailed Description

Defines common elements of all database classes. These are the characteristics — a name and a state — that belong to all Itzam database objects.

Constructor & Destructor Documentation

itzam::database_object::database_object ( const string & name,

itzam_file_lock_mode lock_mode

) [inline]

A database will be in an uninitialized state until all constructors have completed their tasks (such as opening or creating files).
Parameters:

name Database file name

lock_mode File-locking mode

itzam::database_object::database_object ( const database_object & source ) [inline]

A copy of a database object will have the same state.
Parameters:

source The object to be copied.

Member Function Documentation

itzam_file_lock_mode itzam::database_object::get_lock_mode ( ) const [inline]

Returns the file-locking mode for the target database.
Returns:
Current file-locking value for the target database.

string itzam::database_object::get_name ( ) const [inline]

Returns the name for the target database.
Returns:
Current file name for the target database.

database_state itzam::database_object::get_state ( ) const [inline]

Returns the current state value for the target database.
Returns:
Current state value for the target database.

bool itzam::database_object::is_broken ( ) const [inline]

Is this database broken and unstable? Note that a "broken" database is probably not corrupted; this state merely means that the database object is in an undeterminant state, and should not be used.
Returns:
true if the database is "broken"; false otherwise

bool itzam::database_object::is_closed ( ) const [inline]

Is this database closed?
Returns:
true if the database is closed; false otherwise

bool itzam::database_object::is_okay ( ) const [inline]

The "okay" state is defined as any state other than "broken".
Returns:
false if the database state is "broken"; true otherwise

bool itzam::database_object::is_open ( ) const [inline]

Is this database open and ready for changes?
Returns:
true if the database is open; false otherwise

database_object& itzam::database_object::operator= ( const database_object & source ) [inline]

Assigning one database object to another will copy the state.
Parameters:

source The object to be copied.

Returns:
The target object

The documentation for this class was generated from the following file:

itzam_common.h