All Classes Files Functions Variables Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
OutPut Class Reference

Prints summary and error information from objects. More...

#include <output.hpp>

Public Member Functions

 OutPut ()
 The default constructor. More...
 
 OutPut (Library *, vector< ErrorHandler > &, ConfigOpts *)
 The standard constructor for the OutPut class. More...
 
 ~OutPut ()
 The default destructor. More...
 

Static Public Member Functions

static void outputSummary (Library *, ConfigOpts *, ostream &, int)
 Outputs a summary of an input Library object. More...
 
static void outputError (vector< ErrorHandler > &, ostream &)
 Outputs the given error information to the given stream. More...
 
static void outputTasks (Episode *, ConfigOpts *, ostream &)
 Outputs to the given stream the commands needed to perform the requested tasks. More...
 
static void outputXML (Library *, ostream &)
 Outputs summary information from objects in XML format. More...
 
static void outputMissing (Library *, ostream &)
 Outputs gaps in a given Library object's contents. More...
 

Static Private Member Functions

static bool isDir (Episode *)
 Checks if the object's new directory exists yet. More...
 
static string xmlParse (string)
 Replaces "&" with xml "&amp;" in a given string. More...
 

Private Attributes

ostream * tout
 Temporary output stream pointer, to store output file stream object address. More...
 
ofstream lout
 Output file stream object for a log file. More...
 
ofstream sout
 Output file stream object for a script file. More...
 
ofstream fout
 Output file stream object for a file (WTF?) More...
 

Detailed Description

Prints summary and error information from objects.

It also outputs commands with the appropriate directory information needed to perform tasks. This class can output to the console as a test, to a script file for batch processing, or internally perform them.

Definition at line 28 of file output.hpp.

Constructor & Destructor Documentation

OutPut::OutPut ( )

The default constructor.

Definition at line 16 of file mainOutput.cpp.

OutPut::OutPut ( Library libObj,
vector< ErrorHandler > &  fail,
ConfigOpts confObj 
)

The standard constructor for the OutPut class.

Parameters
libObj- the Library object whose contents are to be used to determine the output requirements.
fail- the vector ErrorHandler for this process.
confObj- the ConfigOpts object that contains configuration information to be used to determine the output requirements.

Definition at line 25 of file mainOutput.cpp.

Here is the call graph for this function:

OutPut::~OutPut ( )

The default destructor.

Definition at line 151 of file mainOutput.cpp.

Member Function Documentation

bool OutPut::isDir ( Episode epObj)
staticprivate

Checks if the object's new directory exists yet.

Parameters
epObj- the Episode object containing the information to check.
Returns
A boolean, True for 'directory exists,' false otherwise.

Definition at line 108 of file tasks.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void OutPut::outputError ( vector< ErrorHandler > &  fail,
ostream &  tout 
)
static

Outputs the given error information to the given stream.

Parameters
fail- the vector ErrorHandler object containing the information to be output.
tout- the ostream object to which the output will be sent.

Definition at line 222 of file mainOutput.cpp.

Here is the caller graph for this function:

void OutPut::outputMissing ( Library libObj,
ostream &  tout 
)
static

Outputs gaps in a given Library object's contents.

Such as if a single episode or season were missing from a particular show. It is useful for verifying in large collections that all episodes are accounted for.

Parameters
libObj- the Library object to be checked for missing items.
tout- the ostream object to which the output will be sent.

Definition at line 17 of file gap.cpp.

Here is the caller graph for this function:

void OutPut::outputSummary ( Library libObj,
ConfigOpts confObj,
ostream &  tout,
int  errInt 
)
static

Outputs a summary of an input Library object.

Parameters
libObj- the Library object that contains the information that will be summarized.
confObj- the ConfigOpts object containing the configuration of how the information will be prepared.
tout- the ostream object to which the summary will be output.
errInt- the number of errors counted by the parser.

Definition at line 161 of file mainOutput.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void OutPut::outputTasks ( Episode libObj,
ConfigOpts confObj,
ostream &  tout 
)
static

Outputs to the given stream the commands needed to perform the requested tasks.

Task examples include deleting files, moving files, renaming files, creating directories, among others.

Parameters
libObj- the Episode object which contains the episode's information.
confObj- the ConfigOpts object which contains the configuration information.
tout- the ostream object to which the output will be sent.

Definition at line 20 of file tasks.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void OutPut::outputXML ( Library libObj,
ostream &  tout 
)
static

Outputs summary information from objects in XML format.

Outputs summary information from objects in XML format.

Parameters
libObj- the Library object containing data to be used.
tout- the ostream object to which the output is sent.

Definition at line 18 of file xml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

string OutPut::xmlParse ( string  xmlString)
staticprivate

Replaces "&" with xml "&amp;" in a given string.

Parameters
xmlString- the string containing ampersands to be updated.

Definition at line 80 of file xml.cpp.

Here is the caller graph for this function:

Member Data Documentation

ofstream OutPut::fout
private

Output file stream object for a file (WTF?)

Definition at line 53 of file output.hpp.

ofstream OutPut::lout
private

Output file stream object for a log file.

Definition at line 51 of file output.hpp.

ofstream OutPut::sout
private

Output file stream object for a script file.

Definition at line 52 of file output.hpp.

ostream* OutPut::tout
private

Temporary output stream pointer, to store output file stream object address.

Definition at line 50 of file output.hpp.


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