Episode Class Reference

Stores parsed file information regarding a single episode; to be used as a vector. More...

#include <episode.hpp>

Public Member Functions
	Episode ()
	Default constructor. More...
	Episode (int, int, string, string, string, string, string, string)
	Saves the info required to describe a particular episode. More...
	~Episode ()
	Default destructor. More...
bool	reset (int, int, string, string, string, string, string, string)
	Resets the info required to describe a particular episode. More...
int	getNumber () const
int	getExtra () const
string	getPart () const
string	getTitle () const
string	getOldFile () const
string	getOldDir () const
string	getFilename () const
string	getDirectory () const

Private Attributes
int	number
	The episode number. More...
int	extra
	The extra episode number. More...
string	part
	The episode part. More...
string	title
	The name of the episode. More...
string	oldfile
	The old name of the file. More...
string	olddir
	The old location of the file on disk. More...
string	filename
	The new name of the file. More...
string	directory
	The new location of the file on disk. More...

Detailed Description

Stores parsed file information regarding a single episode; to be used as a vector.

The information stored in an Episode type object can contain: episode number, extra episode number, partial episode number, name of the episode (title), old filename, old directory, new filename, new directory.

Definition at line 25 of file episode.hpp.

Constructor & Destructor Documentation

Episode::Episode

(

)

Default constructor.

Definition at line 23 of file episode.cpp.

Episode::Episode	(	int	num,
		int	xep,
		string	pep,
		string	titl,
		string	file1,
		string	dir1,
		string	file2,
		string	dir2
	)

Saves the info required to describe a particular episode.

Parameters

num	- the episode number
xep	- the end number of a multi-episode file
pep	- the information for a multi-part episode file
titl	- the title of the episode
file1	- the original file name
dir1	- the original directory path
file2	- the modified file name
dir2	- the modified directory path

Definition at line 35 of file episode.cpp.

Episode::~Episode

(

)

Default destructor.

Definition at line 57 of file episode.cpp.

Member Function Documentation

string Episode::getDirectory

(

)

const

Returns

Episode::directory - the new directory

Definition at line 137 of file episode.cpp.

Here is the caller graph for this function:

int Episode::getExtra

(

)

const

Returns

Episode::extra - the extra episode number

Definition at line 101 of file episode.cpp.

Here is the caller graph for this function:

string Episode::getFilename

(

)

const

Returns

Episode::filename - the new file name

Definition at line 131 of file episode.cpp.

Here is the caller graph for this function:

int Episode::getNumber

(

)

const

Returns

Episode::number - the episode number

Definition at line 95 of file episode.cpp.

Here is the caller graph for this function:

string Episode::getOldDir

(

)

const

Returns

Episode::olddir - the old directory

Definition at line 125 of file episode.cpp.

Here is the caller graph for this function:

string Episode::getOldFile

(

)

const

Returns

Episode::oldfile - the old file name

Definition at line 119 of file episode.cpp.

Here is the caller graph for this function:

string Episode::getPart

(

)

const

Returns

Episode::part - the partial episode number

Definition at line 107 of file episode.cpp.

Here is the caller graph for this function:

string Episode::getTitle

(

)

const

Returns

Episode::title - the episode title

Definition at line 113 of file episode.cpp.

Here is the caller graph for this function:

bool Episode::reset	(	int	num,
		int	xep,
		string	pep,
		string	titl,
		string	file1,
		string	dir1,
		string	file2,
		string	dir2
	)

Resets the info required to describe a particular episode.

Parameters

num	- the episode number
xep	- the end number of a multi-episode file
pep	- the information for a multi-part episode file
titl	- the title of the episode
file1	- the original file name
dir1	- the original directory path
file2	- the modified file name
dir2	- the modified directory path

Returns

a boolean value of true

Definition at line 70 of file episode.cpp.

Here is the caller graph for this function:

Member Data Documentation

string Episode::directory

private

The new location of the file on disk.

Definition at line 55 of file episode.hpp.

int Episode::extra

private

The extra episode number.

Definition at line 49 of file episode.hpp.

string Episode::filename

private

The new name of the file.

Definition at line 54 of file episode.hpp.

int Episode::number

private

The episode number.

Definition at line 48 of file episode.hpp.

string Episode::olddir

private

The old location of the file on disk.

Definition at line 53 of file episode.hpp.

string Episode::oldfile

private

The old name of the file.

Definition at line 52 of file episode.hpp.

string Episode::part

private

The episode part.

Definition at line 50 of file episode.hpp.

string Episode::title

private

The name of the episode.

Definition at line 51 of file episode.hpp.

---

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

• headers/episode.hpp
• sources/catalog/episode.cpp