SAR<em>bayes</em>: SORAL Documentation
(SARBayes) Main Related Pages Class List Hierarchy Methods Files

AreaAssignment Class Reference

#include <containr.h>

List of all members.


Detailed Description

An assignment of an area and a time. It must belong to a resource to have meaning.

Logically a tuple (area, time), an AreaAssignment is a pair of numbers belonging to a resource, giving an area to which that resource has been assigned, and the time for which it has been assigned to that area. A resource can have many AreaAssignments.

Author : Michael Eldridge

Definition at line 82 of file containr.h.

Public Member Functions

 AreaAssignment (const int p_areaNum, const double p_time)
 Constructor for AreaAssignment, given (area number, time).

 AreaAssignment (const AreaAssignment &p_areaAssignment)
 Copy constructor for AreaAssignment.

int getAreaNum (void) const
 Returns the area number stored in this AreaAssignment.

double getTime (void) const
 Returns the time stored in this AreaAssignment.


Private Member Functions

AreaAssignment & operator= (const AreaAssignment &p_areaAssignment)

Private Attributes

const int areaNum
 The area number part of this tuple. Immutable copy from Allocation.

const double time
 The time part of this tuple. Immutable copy from Allocation.


Constructor & Destructor Documentation

AreaAssignment::AreaAssignment const int    p_areaNum,
const double    p_time
 

Constructor for AreaAssignment, given (area number, time).

Author : Michael Eldridge

Definition at line 63 of file con_area.cpp.

AreaAssignment::AreaAssignment const AreaAssignment &    p_areaAssignment
 

Copy constructor for AreaAssignment.

Author : Charles Twardy

Definition at line 75 of file con_area.cpp.


Member Function Documentation

int AreaAssignment::getAreaNum void    const
 

Returns the area number stored in this AreaAssignment.

We use a "get" function with no "set" function (rather than just declaring the variable public) so that the calling function cannot change the data.

Author : Michael Eldridge

Definition at line 93 of file con_area.cpp.

References areaNum.

Referenced by AreaIterator::operator++().

double AreaAssignment::getTime void    const
 

Returns the time stored in this AreaAssignment.

We use a "get" function with no "set" function (rather than just declaring the variable public) so that the calling function cannot change the data.

Author : Michael Eldridge

Definition at line 109 of file con_area.cpp.

References time.


Member Data Documentation

const int AreaAssignment::areaNum [private]
 

The area number part of this tuple. Immutable copy from Allocation.

The (area number, time) tuple stored in this object contains copies of the values stored in the relevant Allocation object. This object does not allow these values to be modified because this could potentially cause confusion: people would think they were modifying the assignments stored in the Allocation object itself, but they would not actually be doing so.

Definition at line 112 of file containr.h.

Referenced by getAreaNum().


The documentation for this class was generated from the following files:
Generated on Fri May 9 17:04:31 2003 for SORAL by dOxygen 1.3-rc3
(SARBayes) Main Related Pages Class List Hierarchy Methods Files