XeObject Class Reference

Basic Xephyr Object. More...

#include <XeCore.h>

Inheritance diagram for XeObject:

List of all members.

Public Member Functions
void	addName (string n)
void	attach (XeObject *daughter)
	attach a daughter object
bool	check ()
	Check the object, recompute what is needed, and fill the status.
bool	checkAll ()
	return cumulated status
virtual bool	checkIt ()
	Virtual method which checks the object, fill its status and returns if checked OK.
void	detach (XeObject *daughter)
	detach a daughter object and reattach it to the top object
void	detachItself ()
	detach an object from its father and reattach it to the top object
void	doNotMarkAsChanged ()
	Do nothing (introduced for legibility reasons).
XeObject *	getDown (int g)
	get one object down in the tree
vector< XeObject * > *	getDowns ()
	get the vector of down objects
virtual string	getFrameName ()
string	getLaTeXName ()
	get the name in LateX format
string	getLegend ()
	get the Legend name
string	getMiniStatusName ()
	return the object status name
string	getName ()
	get the name
const char *	getNameChar ()
	get the a point to the name
string	getNameSpace ()
	get the name and add a space
int	getNDowns ()
	get the number of objects below the current one
string	getReference ()
	get the name of the reference
int	getStatus ()
	Return the object status.
string	getStatusName ()
	return the object status name
XeObject *	getUp ()
	get the father in the tree
bool	hasLegend ()
bool	hasName ()
bool	isChanged ()
	track changes in objects
bool	isCheckedOK ()
	Is the object checked OK?
bool	isError ()
	Is the object in error) ?
bool	isOK ()
	Is the object either OK or unchecked (i.e.
bool	isReferenced ()
	static XeTopObject* theInstance;
void	linkUp (XeObject *up)
	Update pointer to father.
void	markAsChanged (bool propagateUp=true)
	mark the object as changed
void	markAsRecomputed ()
	mark the object as recomputed
void	markError ()
	mark the object in error
void	markFromCheck (bool ok)
	mark the result of a check as CKECKED_OK, IN_ERROR
void	markOK ()
	mark the object OK
void	markUnchecked ()
	mark the object unchecked
void	openCanvas (int nx=1, int ny=1, bool square=false)
	get create a graphical canvas with the object name
bool	print (int level=1)
	print the XeObject properties This is a workaround for invoking "bool printIt(int)" in interactive ROOT
virtual bool	printIt (int level=1)
	Virtual method to print the object.
void	printReference (int ntab=0)
void	printTree (int depth=12345, int offset=0)
	Print the tree belowe current object.
void	read (string name="")
	Simple wrapper to read from an already opened file.
void	readFromSimpleFile (string fName="", string oName="")
	Read an object from a newly recreared file containing this object only.
void	setFrameName (string frame)
void	setLaTeXName (string latex)
void	setLegend (string legend="")
void	setName (const char *n)
virtual void	setName (string n)
	set the object name This method can be overriden
void	setReference (string ref)
void	setXenon100Reference (string xenonRef)
void	trace (trackingPoint tp, string method)
	Trace the method entry point or exit point.
virtual void	traceFlags ()
	Virtual method to trace its internal flags This is a workaround for invoking "traceTheFlags" in interactive ROOT.
void	write (string name="")
	Simple wrapper to Write to an already opened file.
void	writeToSimpleFile (string fName="", string oName="")
	Write an object to a newly recreared file containing this object only.
	XeObject (string name)
Static Public Member Functions
static string	getMiniStatusName (int s)
	Return the object mini status name, given its name.
static string	getResultsDirectory ()
static string	getStatusName (int s)
	Return the object status name, given its name.
static XeTopObject *	getTop ()
	return a pointer to the top object
static void	setResultsDirectory (string dir="")
static void	showTheReferences (bool show=true)
	Switch the "show references" flag on/off.
static bool	withReference ()
Protected Member Functions
void	initializeObject (string n=UNDEFINED_STRING)
	Internal method for initialization.
virtual void	traceTheFlags ()
	Virtual method to trace its internal flags.
Protected Attributes
bool	changed
vector< XeObject * >	downs
	do not save
string	FrameName
string	LaTeXName
string	legend
string	Name
string	Reference
int	status
XeObject *	up
string	upName
Static Protected Attributes
static string	resultsDirectory
static bool	showReference

---

Detailed Description

Basic Xephyr Object.

Later on, will extend TObject

---

Member Function Documentation

void XeObject::attach

(

XeObject *

daughter

)

attach a daughter object

Parameters:

daughter

pointer to daughter object

bool XeObject::check

(

)

Check the object, recompute what is needed, and fill the status.

This is a workaround for invoking "bool checkIt()" in interactive ROOT

Returns:

flag telling that everything is ok

void XeObject::detach

(

XeObject *

daughter

)

detach a daughter object and reattach it to the top object

Parameters:

daughter

pointer to daughter object

void XeObject::detachItself

(

)

detach an object from its father and reattach it to the top object

Parameters:

up

pointer to new father XeObject

XeObject* XeObject::getDown

(

int

g

)

get one object down in the tree

Parameters:

g

sequence number of the object

Returns:

pointer to the object

vector<XeObject*>* XeObject::getDowns

(

)

get the vector of down objects

Returns:

pointer to the object

static string XeObject::getMiniStatusName

(

int

s

)

[static]

Return the object mini status name, given its name.

Parameters:

s

status

int XeObject::getStatus

(

)

Return the object status.

Returns:

UNCHECKED, CHECKED_OK or IN_ERROR

static string XeObject::getStatusName

(

int

s

)

[static]

Return the object status name, given its name.

Parameters:

s

status

XeObject* XeObject::getUp

(

)

get the father in the tree

Returns:

a pointer to the father

bool XeObject::hasLegend

(

)

Returns:

This object has a legend (for MultiGraphs)

bool XeObject::hasName

(

)

Returns:

This object has a name

bool XeObject::isChanged

(

)

track changes in objects

Returns:

did the object changed?

bool XeObject::isOK

(

)

Is the object either OK or unchecked (i.e.

not in error) ?

bool XeObject::isReferenced

(

)

static XeTopObject* theInstance;

Returns:

This object has a reference

void XeObject::linkUp

(

XeObject *

up

)

Update pointer to father.

Warning! internal method

Parameters:

up

pointer to father XeObject

void XeObject::markAsChanged

(

bool

propagateUp = true

)

mark the object as changed

Parameters:

propagateUp,:

the upper objects are also marked as changed

void XeObject::markFromCheck

(

bool

ok

)

mark the result of a check as CKECKED_OK, IN_ERROR

Parameters:

ok

the result went ok

void XeObject::openCanvas	(	int	nx = 1,
		int	ny = 1,
		bool	square = false
	)

get create a graphical canvas with the object name

Parameters:

	nx	divide it in nx columns of sub canvases
	ny	divide it in ny rows of subcanvas
	square	make it square

bool XeObject::print

(

int

level = 1

)

print the XeObject properties This is a workaround for invoking "bool printIt(int)" in interactive ROOT

Returns:

true if no error was found

Parameters:

level

print level

virtual bool XeObject::printIt

(

int

level = 1

)

[virtual]

Virtual method to print the object.

Returns:

true if no error was found

Parameters:

level

print level

Reimplemented in XeSetOfCuts, SelectionCut, XeSetOfSelectionCuts, S1S2Data, S1Slice, S2Band, S1S2Bands, ElectronBackgroundModel, SimplisticERBackground, SimpleERBackground, PublishedElectronBackground, XeRun, S1S2PL, XeTable, XeStyle, XeGraph, XeMultiGraph, XeBins, XeRange, Nucleus, LedererTable, Target, XeValues, XeSpectrum, TabulatedDist, XeSigma, XeLimit, XeSigmas, XeLimits, XeSensitivity, SensitivityBands, and DataSet.

void XeObject::printTree	(	int	depth = 12345,
		int	offset = 0
	)

Print the tree belowe current object.

Parameters:

	depth	how deep we go
	offset	tabulation offset

void XeObject::read

(

string

name = ""

)

Simple wrapper to read from an already opened file.

Parameters:

name

of the object to be read. If none, use the XeGraph name;

Reimplemented in XeSigmas, XeLimits, and SensitivityBands.

void XeObject::readFromSimpleFile	(	string	fName = "",
		string	oName = ""
	)

Read an object from a newly recreared file containing this object only.

Parameters:

	fName	name of the file to be written. If none, use the object name;
	nName	name of the object to be read;
	name	of the object to be read. If none, use the file name;

void XeObject::trace	(	trackingPoint	tp,
		string	method
	)

Trace the method entry point or exit point.

Parameters:

	tp	tracking point (either ENTRY or Exit)
	method	method name

void XeObject::write

(

string

name = ""

)

Simple wrapper to Write to an already opened file.

Parameters:

name

of the object to be written. If none, use the XeGraph name;

void XeObject::writeToSimpleFile	(	string	fName = "",
		string	oName = ""
	)

Write an object to a newly recreared file containing this object only.

Parameters:

	fName	name of the file to be written. If none, use the object name;
	oName	name of the object to be written. If none, use the object name;

---

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

• /home/lellouch/Dropbox/Xenon/Xephyr/XeCore.h