IsMinor Class Reference

Class for "is minor". More...

#include <is_minor.h>

Inheritance diagram for IsMinor:

Collaboration diagram for IsMinor:

Public Member Functions
	IsMinor (MinorType)
	Constructs the IsMinor object. More...
	IsMinor (bool)
	Constructs the IsMinor object. More...
FieldType	getType ()
	Gets the type under the FieldType enum. More...
MinorType	getMinorType ()
	Gets the minor type of the Course. More...
std::string	getTypeName ()
	Gets the type name, which is "Minor Type". More...
std::string	getName ()
	Gets whether the Course is a minor course or not. More...

Detailed Description

Class for "is minor".

This represents whether a Course is a minor course or not.

Constructor & Destructor Documentation

IsMinor::IsMinor

(

MinorType

minorType

)

Constructs the IsMinor object.

Parameters

[in]

minorType

The minor type of the Course

IsMinor::IsMinor

(

bool

isMinor

)

Constructs the IsMinor object.

Parameters

[in]

isMinor

Indicates if the Course is a minor course

Member Function Documentation

MinorType IsMinor::getMinorType

(

)

Gets the minor type of the Course.

Returns

The minor type.

std::string IsMinor::getName

(

)

Gets whether the Course is a minor course or not.

Returns

"Yes" if it is a minor course, "No" if not

FieldType IsMinor::getType ( )

virtual

Gets the type under the FieldType enum.

Returns

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

Implements Field.

std::string IsMinor::getTypeName ( )

virtual

Gets the type name, which is "Minor Type".

Returns

The string "Minor Type"

Implements Field.

---

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

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