The Librarian class keeps track of the different library objects for a run.
More...
#include <library.h>
List of all members.
Public Member Functions |
| Librarian (size_t num_libs) |
| Librarian Constructor.
|
Library & | operator[] (size_t i) |
| An accessor for the Library struct at a given index.
|
const Library & | curr_lib () const |
| An accessor for the Library struct associated with the library currently being processed.
|
void | set_curr (size_t i) |
| A mutator of the index of the library currently being processed.
|
size_t | size () const |
| An accessor for the number of Library structs.
|
Detailed Description
The Librarian class keeps track of the different library objects for a run.
- Author:
- Adam Roberts
- Date:
- 2012 Artistic License 2.0
Definition at line 75 of file library.h.
Constructor & Destructor Documentation
Librarian::Librarian |
( |
size_t |
num_libs | ) |
[inline] |
Librarian Constructor.
- Parameters:
-
num_libs | a size_t for the number of libraries to be processed in the run. |
Definition at line 92 of file library.h.
Member Function Documentation
const Library& Librarian::curr_lib |
( |
| ) |
const [inline] |
An accessor for the Library struct associated with the library currently being processed.
Returned value does not outlive this.
- Returns:
- The Library struct indexed by _curr.
Definition at line 108 of file library.h.
Library& Librarian::operator[] |
( |
size_t |
i | ) |
[inline] |
An accessor for the Library struct at a given index.
Returned value does not outlive this.
- Parameters:
-
i | a size_t indexing the requested Library struct. |
- Returns:
- The Library struct at the given index.
Definition at line 99 of file library.h.
void Librarian::set_curr |
( |
size_t |
i | ) |
[inline] |
A mutator of the index of the library currently being processed.
- Parameters:
-
i | a size_t to set the index of the current Library struct to. |
Definition at line 113 of file library.h.
size_t Librarian::size |
( |
| ) |
const [inline] |
An accessor for the number of Library structs.
This should be equal to the number of libraries to be processed in the run.
- Returns:
- The number of Library structs.
Definition at line 122 of file library.h.
The documentation for this class was generated from the following file: