Public Member Functions | Public Attributes | List of all members
JobOption Class Reference

the JobOption class. More...

#include <OSOption.h>

Collaboration diagram for JobOption:
Collaboration graph
[legend]

Public Member Functions

 JobOption ()
 Default constructor. More...
 
 ~JobOption ()
 Class destructor. More...
 
bool IsEqual (JobOption *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (JobOption *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

TimeSpanmaxTime
 the maximum time allowed More...
 
std::string requestedStartTime
 the requested time to start the job More...
 
JobDependenciesdependencies
 the dependency set More...
 
DirectoriesAndFilesrequiredDirectories
 directories required to run the job More...
 
DirectoriesAndFilesrequiredFiles
 files required to run the job More...
 
DirectoriesAndFilesdirectoriesToMake
 directories to make during the job More...
 
DirectoriesAndFilesfilesToMake
 files to make during the job More...
 
PathPairsinputDirectoriesToMove
 input directories to move or copy More...
 
PathPairsinputFilesToMove
 input files to move or copy More...
 
PathPairsoutputFilesToMove
 output files to move or copy More...
 
PathPairsoutputDirectoriesToMove
 output directories to move or copy More...
 
DirectoriesAndFilesfilesToDelete
 files to delete upon completion More...
 
DirectoriesAndFilesdirectoriesToDelete
 directories to delete upon completion More...
 
ProcessesprocessesToKill
 processes to kill upon completion More...
 
OtherOptionsotherOptions
 list of other job options More...
 

Detailed Description

the JobOption class.

Author
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version
1.0, 21/07/2008
Since
OS 1.1
Remarks
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 1064 of file OSOption.h.

Constructor & Destructor Documentation

JobOption::JobOption ( )

Default constructor.

Definition at line 378 of file OSOption.cpp.

JobOption::~JobOption ( )

Class destructor.

Definition at line 400 of file OSOption.cpp.

Member Function Documentation

bool JobOption::IsEqual ( JobOption that)

A function to check for the equality of two objects.

Definition at line 9822 of file OSOption.cpp.

bool JobOption::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters
density,:corresponds to the probability that a particular child element is created
conformant,:if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 12331 of file OSOption.cpp.

bool JobOption::deepCopyFrom ( JobOption that)

A function to make a deep copy of an instance of this class.

Parameters
that,:the instance from which information is to be copied
Returns
whether the copy was created successfully

Definition at line 13446 of file OSOption.cpp.

Member Data Documentation

TimeSpan* JobOption::maxTime

the maximum time allowed

Definition at line 1069 of file OSOption.h.

std::string JobOption::requestedStartTime

the requested time to start the job

Definition at line 1072 of file OSOption.h.

JobDependencies* JobOption::dependencies

the dependency set

Definition at line 1075 of file OSOption.h.

DirectoriesAndFiles* JobOption::requiredDirectories

directories required to run the job

Definition at line 1078 of file OSOption.h.

DirectoriesAndFiles* JobOption::requiredFiles

files required to run the job

Definition at line 1081 of file OSOption.h.

DirectoriesAndFiles* JobOption::directoriesToMake

directories to make during the job

Definition at line 1084 of file OSOption.h.

DirectoriesAndFiles* JobOption::filesToMake

files to make during the job

Definition at line 1087 of file OSOption.h.

PathPairs* JobOption::inputDirectoriesToMove

input directories to move or copy

Definition at line 1090 of file OSOption.h.

PathPairs* JobOption::inputFilesToMove

input files to move or copy

Definition at line 1093 of file OSOption.h.

PathPairs* JobOption::outputFilesToMove

output files to move or copy

Definition at line 1096 of file OSOption.h.

PathPairs* JobOption::outputDirectoriesToMove

output directories to move or copy

Definition at line 1099 of file OSOption.h.

DirectoriesAndFiles* JobOption::filesToDelete

files to delete upon completion

Definition at line 1102 of file OSOption.h.

DirectoriesAndFiles* JobOption::directoriesToDelete

directories to delete upon completion

Definition at line 1105 of file OSOption.h.

Processes* JobOption::processesToKill

processes to kill upon completion

Definition at line 1108 of file OSOption.h.

OtherOptions* JobOption::otherOptions

list of other job options

Definition at line 1111 of file OSOption.h.


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