luiza::CCProcessor Class Reference

#include <CCProcessor.h>

Public Member Functions
bool	hasErrors ()
bool	hasParameters ()
bool	hasErrorCols ()
bool	isInstalled ()
bool	isActive ()
bool	hasCondition (const std::string &condition)
const std::string &	getName ()
const std::string &	getType ()
sSet &	getConditions ()
const std::string	getDescription ()
const std::string	getError ()
const std::string	getStatusDesc ()
bool	isErrorCol (const std::string &type, const std::string &value)
bool	isParamOptional (const std::string &key)
StringParameters *	getParameters ()
const ssMap &	getColHeaders (const std::string &iotype)
ColVec &	getCols (const std::string &iotype, const std::string &type_name="ALL_COLLECTIONS")
sSet &	getColTypeNames (const std::string &iotype)
void	addCol (const std::string &iotype, const std::string &name, const std::string &type, const std::string &value)
void	remCol (const std::string &iotype, const std::string &name, unsigned int index)
void	addUCol (CCCollection *c)
void	addDCol (CCCollection *c)
void	changeStatus ()
void	setName (const std::string &name)
void	setConditions (const std::string &conditions)
void	setError (int error)
void	clearError (int error)
void	setOptionalParam (const std::string &key, bool optional=true)
void	writeToXML (std::ofstream &stream)

Detailed Description

handles information about luiza processors and their collections needed by LuizaSteerCheck

Author

Jan Engels, Benjamin Eberhardt, DESY

Version

Id

CCProcessor.h,v 1.23 2007-01-11 16:56:37 engels Exp

Member Function Documentation

void luiza::CCProcessor::addCol	(	const std::string &	iotype,
		const std::string &	name,
		const std::string &	type,
		const std::string &	value
	)

Adds a collection of the given iotype ( INPUT / OUTPUT ) with the given name, type and value

void luiza::CCProcessor::addDCol

(

CCCollection *

c

)

Adds a duplicate collection to this processor

References setError().

void luiza::CCProcessor::addUCol

(

CCCollection *

c

)

Adds an unavailable collection to this processor

References setError().

void luiza::CCProcessor::changeStatus

(

)

Changes the processor status ( ACTIVE->INACTIVE or INACTIVE->ACTIVE )

References clearError().

void luiza::CCProcessor::clearError

(

int

error

)

Clears an error flag in this processor ( NO_PARAMETERS=0, NOT_INSTALLED=1, COL_ERRORS=2 )

Referenced by changeStatus().

const ssMap& luiza::CCProcessor::getColHeaders ( const std::string &  iotype )

inline

Returns a map with collection names and their respective types for INPUT/OUTPUT collections of this processor

ColVec & luiza::CCProcessor::getCols	(	const std::string &	iotype,
		const std::string &	type_name = "ALL_COLLECTIONS"
	)

Returns collections of a given iotype ( INPUT, OUTPUT, UNAVAILABLE, DUPLICATE ) for a given name or type If iotype == INPUT/OUTPUT then type_name is the name of the collection If iotype == UNAVAILABLE/DUPLICATE then type_name is the type of the collection

Referenced by luiza::LuizaSteerCheck::getColsSet(), and isErrorCol().

sSet & luiza::CCProcessor::getColTypeNames

(

const std::string &

iotype

)

Returns collection's types/names of a given iotype found in the processor If iotype == INPUT/OUTPUT then names are returned If iotype == UNAVAILABLE/DUPLICATE/MISSING then types are returned

sSet& luiza::CCProcessor::getConditions ( )

inline

Returns the Conditions of the processor

const std::string luiza::CCProcessor::getDescription ( )

inline

Returns the Description of the processor

References luiza::Processor::description(), and isInstalled().

Referenced by writeToXML().

const std::string luiza::CCProcessor::getError ( )

inline

Returns a string with the error of the processor

const std::string& luiza::CCProcessor::getName ( )

inline

Returns the Name of the processor

StringParameters* luiza::CCProcessor::getParameters ( )

inline

Returns the string parameters for this processor

const std::string luiza::CCProcessor::getStatusDesc ( )

inline

Returns a string with the processor status ( "Active", "Inactive" )

References isActive().

const std::string& luiza::CCProcessor::getType ( )

inline

Returns the Type of the processor

bool luiza::CCProcessor::hasCondition

(

const std::string &

condition

)

Returns true if the processor is constrained by the given condition

bool luiza::CCProcessor::hasErrorCols ( )

inline

Returns true if the processor has collection errors

bool luiza::CCProcessor::hasErrors

(

)

Returns true if the processor has errors

bool luiza::CCProcessor::hasParameters ( )

inline

Returns true if the processor has parameters

Referenced by writeToXML().

bool luiza::CCProcessor::isActive ( )

inline

Returns true if the processor is active

Referenced by luiza::LuizaSteerCheck::getColsSet(), and getStatusDesc().

bool luiza::CCProcessor::isErrorCol	(	const std::string &	type,
		const std::string &	value
	)

Returns true if the given collection is in the unavailable or duplicate list of this processor

References getCols().

bool luiza::CCProcessor::isInstalled ( )

inline

Returns true if the processor is installed

Referenced by getDescription(), and writeToXML().

bool luiza::CCProcessor::isParamOptional

(

const std::string &

key

)

Returns true if a parameter is optional (optional means the parameter will be written out as a comment)

References luiza::CMProcessor::instance().

Referenced by writeToXML().

void luiza::CCProcessor::remCol	(	const std::string &	iotype,
		const std::string &	name,
		unsigned int	index
	)

Removes collection of the given iotype ( INPUT / OUTPUT ) with the given name at the given index

void luiza::CCProcessor::setConditions

(

const std::string &

conditions

)

Sets the processor's conditions

void luiza::CCProcessor::setError

(

int

error

)

Activates an error flag in this processor ( NO_PARAMETERS=0, NOT_INSTALLED=1, COL_ERRORS=2 )

Referenced by addDCol(), and addUCol().

void luiza::CCProcessor::setName ( const std::string &  name )

inline

Sets the processor's name

void luiza::CCProcessor::setOptionalParam	(	const std::string &	key,
		bool	optional = true
	)

Sets a parameter as optional (if optional=true parameter is written out as a comment)

void luiza::CCProcessor::writeToXML

(

std::ofstream &

stream

)

Writes this processor to a stream using the XML format

References getDescription(), luiza::CMProcessor::getParam(), luiza::CMProcessor::getParamD(), luiza::CMProcessor::getParamSetSize(), hasParameters(), luiza::CMProcessor::instance(), isInstalled(), and isParamOptional().

---

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

• CCProcessor.h
• CCProcessor.cc