Instructor Class Reference

Class for an instructor. More...

#include <instructor.h>

Inheritance diagram for Instructor:

Collaboration diagram for Instructor:

Public Member Functions
	Instructor (std::string)
	Constructs the Instructor object. More...
bool	operator== (const Instructor &other)
	Checks if two Instructor objects are identical, i.e., if both have the same name. More...
FieldType	getType ()
	Gets the type under the FieldType enum. More...
std::string	getName ()
	Gets the name of the Instructor. More...
std::string	getTypeName ()
	Gets the type name, which is "Instructor". More...

Detailed Description

Class for an instructor.

Constructor & Destructor Documentation

Instructor::Instructor

(

std::string

name

)

Constructs the Instructor object.

Parameters

[in]

name

The name of the Instructor, which uniquely identifies the Instructor

Member Function Documentation

std::string Instructor::getName

(

)

Gets the name of the Instructor.

Returns

The name of the Instructor

FieldType Instructor::getType ( )

virtual

Gets the type under the FieldType enum.

Returns

A member of the FieldType enum, which is FieldType::instructor

Implements Field.

std::string Instructor::getTypeName ( )

virtual

Gets the type name, which is "Instructor".

Returns

The string "Instructor"

Implements Field.

bool Instructor::operator==

(

const Instructor &

other

)

Checks if two Instructor objects are identical, i.e., if both have the same name.

Parameters

[in]

other

The Instructor with which the comparison is being made

Returns

true if identical, false otherwise

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/timetabler/checkouts/stable/include/fields/instructor.h
• /home/docs/checkouts/readthedocs.org/user_builds/timetabler/checkouts/stable/src/fields/instructor.cpp