Itzam/C++

Main Index

Created by Scott Robert Ladd at Coyote Gulch Productions.

itzam::ref_list

itzam::ref_list Class Reference

Reference list. More...

#include <complex_database.h>

List of all members.

Public Member Functions

ref_list ()
Default constructor.
ref_list (const set< itzam_ref > &value)
Default constructor.
ref_list (const serial_data &source)
Raw data constructor.
ref_list (const ref_list &source)
Copy constructor.
ref_list & operator= (const ref_list &source)
Assignment.
ref_list & operator= (const set< itzam_ref > &source)
Base Type Assignment.
ref_list & operator= (const serial_data &source)
Base Type Assignment.
~ref_list ()
Destructor.
operator set () const
cast to base type
operator serial_data () const
Get raw object for storage.
bool contains (const itzam_ref &ref)
Does this list contain a given reference?
void add (const itzam_ref &ref)
Add a new reference.
void remove (const itzam_ref &ref)
Remove a reference.
void remove_all ()
Remove all references.
size_t count () const
Get number of references in this list.

Detailed Description

A list of record references, used internally by some index classes to support duplicate keys.

Constructor & Destructor Documentation

itzam::ref_list::ref_list ( ) [inline]

Creates a new object with the default underlying value for data_t.

itzam::ref_list::ref_list ( const set< itzam_ref > & value ) [inline]

Creates a new object with the default underlying value for data_t.

itzam::ref_list::ref_list ( const serial_data & source ) [inline]

Creates a new object from the raw data addressed by source. This implementation uses a simple static cast and assignment; classes that require more complex initialization will need to define a specialization of database_data.
Parameters:

source A serialized reference list

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

Creates a new object that duplicates source. This implementation assumes that data_t has a simple copy constructor.
Parameters:

source An object to be copied

itzam::ref_list::~ref_list ( ) [inline]

This virtual destructor exists so that derived classes can handle any resource releases they may require, if they are destroyed through a pointer to this base class.

Member Function Documentation

void itzam::ref_list::add ( const itzam_ref & ref ) [inline]

Adds the given reference to this list.
Parameters:

ref a file reference

bool itzam::ref_list::contains ( const itzam_ref & ref ) [inline]

Determines if the given reference is in this list.
Parameters:

ref a file reference

Returns:
true if ref was found, false if not

size_t itzam::ref_list::count ( ) const [inline]

Get number of references in this list.
Returns:
number of references in this list

itzam::ref_list::operator serial_data ( ) const [inline]

This function returns a pointer to a nuemric value that represents the underlying value of this object.
Returns:
The value of this object, as raw bytes

itzam::ref_list::operator set ( ) const [inline]

Cast the object to its underlying base type.
Returns:
The value of the object

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

Assigned the value of a data_t object to an existing database_data(data_t>. This This implementation assumes that data_t supports simple assignment.
Parameters:

source An object to be copied

Returns:
A reference to the target object

ref_list& itzam::ref_list::operator= ( const set< itzam_ref > & source ) [inline]

Assigned the value of a data_t object to an existing database_data(data_t>. This implementation assumes that data_t supports simple assignment.
Parameters:

source An object to be copied

Returns:
A reference to the target object

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

Assigned the value of one existing object to another. This implementation assumes that data_t supports simple assignment.
Parameters:

source An object to be copied

Returns:
A reference to the target object

void itzam::ref_list::remove ( const itzam_ref & ref ) [inline]

Removed the given reference to this list.
Parameters:

ref a file reference

void itzam::ref_list::remove_all ( ) [inline]

Removes all references from this list

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

complex_database.h