Detailed Description

Wrapping REST macros into tasks.

REST macros are actually ROOT scripts written in C++. TRestTask wraps them and turns them into application mateadata class. This is done by calling method TInterpreter::LoadFile() and TInterpreter::ProcessLine(). Turning REST-macro-defined functions into classes means that we are able to run the macros from rml file, by adding a section under the section "TRestManager". Another way to launch TRestTask is through restManager executable. By directly typing "restManager TASKNAME [ARG]" in bash we can run the macros like executables. We also allow users to write TRestTask inherted class in REST macros. This can enable more functionalities.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2017-Nov: First concept and implementation of TRestTask Kaixiang Ni

Definition at line 27 of file TRestTask.h.

#include <TRestTask.h>

Inheritance diagram for TRestTask:

Public Member Functions
	ClassDefOverride (TRestTask, 1)

REST_TASKMODE	GetMode () const

void	InitFromConfigFile () override
	Starter method. Looks through the rml sections and set argument/datamenber value. More...

virtual void	PrintArgumentHelp ()
	Default helper method both for TRestTask and any TRestTask-inherited class. More...

virtual void	RunTask (TRestManager *)
	Run the task with command line. More...

void	SetArgumentValue (std::vector< std::string > arg)
	Set argument directly with a list of string. More...

void	SetMode (REST_TASKMODE mod)

	TRestTask ()
	TRestTask default constructor. More...

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Static Public Member Functions
static TRestTask *	GetTaskFromCommand (TString cmd)

static TRestTask *	GetTaskFromMacro (TString Name)
	Static method to instantiate a TRestTask object with "MacroName". More...

Protected Member Functions
	TRestTask (TString TaskString, REST_TASKMODE mode=TASK_MACRO)
	TRestTask constructor with macro file name. More...

Protected Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Protected Attributes
std::vector< std::string >	fArgumentNames

std::vector< int >	fArgumentTypes

std::vector< std::string >	fArgumentValues

std::string	fConstructedCommand = ""

std::string	fInvokeMethod = ""

std::string	fInvokeObject = ""

REST_TASKMODE	fMode

unsigned int	fNRequiredArgument

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestTask() [1/2]

TRestTask::TRestTask	(	TString	TaskString,
		REST_TASKMODE	mode = `TASK_MACRO`
	)

protected

TRestTask constructor with macro file name.

The first method in the file is identified with its name and require arguments saved in the class. They will be used in forming the command line in the method TRestTask::InitTask()

Definition at line 65 of file TRestTask.cxx.

◆ TRestTask() [2/2]

TRestTask::TRestTask ( )

TRestTask default constructor.

Definition at line 51 of file TRestTask.cxx.

◆ ~TRestTask()

TRestTask::~TRestTask ( )

inline

Definition at line 59 of file TRestTask.h.

Member Function Documentation

◆ GetMode()

REST_TASKMODE TRestTask::GetMode ( ) const

inline

Definition at line 55 of file TRestTask.h.

◆ GetTaskFromCommand()

TRestTask * TRestTask::GetTaskFromCommand ( TString cmd )

static

Definition at line 311 of file TRestTask.cxx.

◆ GetTaskFromMacro()

TRestTask * TRestTask::GetTaskFromMacro ( TString taskName )

static

Static method to instantiate a TRestTask object with "MacroName".

REST macros are saved in the directory ./macros. They follow a naming logic, the naming style is like following: REST_[MacroName].hh

e.g. REST_ViewEvents.hh. Here we must add a prefix "REST_" with a macro name usually in verb form. When given the macro name, this method first calls TClass::GetClass() to find if there is a TRestTask-inherted class which has this name. If so, it returns the found class, if not, it finds a corresponding macro file and calls gInterpreter to load it, and then instantiates a TRestTask class wrapping this file.

Definition at line 269 of file TRestTask.cxx.

◆ InitFromConfigFile()

void TRestTask::InitFromConfigFile ( )

overridevirtual

Starter method. Looks through the rml sections and set argument/datamenber value.

Reimplemented from TRestMetadata.

Definition at line 144 of file TRestTask.cxx.

◆ PrintArgumentHelp()

void TRestTask::PrintArgumentHelp ( )

virtual

Default helper method both for TRestTask and any TRestTask-inherited class.

Definition at line 236 of file TRestTask.cxx.

◆ RunTask()

void TRestTask::RunTask ( TRestManager * mgr )

virtual

Run the task with command line.

Definition at line 162 of file TRestTask.cxx.

◆ SetArgumentValue()

void TRestTask::SetArgumentValue ( std::vector< std::string > arg )

Set argument directly with a list of string.

Argument list will be overwritten by the input list. It will also set the data member value for derived class

Definition at line 151 of file TRestTask.cxx.

◆ SetMode()

void TRestTask::SetMode ( REST_TASKMODE mod )

inline

Definition at line 54 of file TRestTask.h.

Field Documentation

◆ fArgumentNames

std::vector<std::string> TRestTask::fArgumentNames

protected

Definition at line 38 of file TRestTask.h.

◆ fArgumentTypes

std::vector<int> TRestTask::fArgumentTypes

protected

Definition at line 37 of file TRestTask.h.

◆ fArgumentValues

std::vector<std::string> TRestTask::fArgumentValues

protected

Definition at line 39 of file TRestTask.h.

◆ fConstructedCommand

std::string TRestTask::fConstructedCommand = ""

protected

Definition at line 40 of file TRestTask.h.

◆ fInvokeMethod

std::string TRestTask::fInvokeMethod = ""

protected

Definition at line 34 of file TRestTask.h.

◆ fInvokeObject

std::string TRestTask::fInvokeObject = ""

protected

Definition at line 33 of file TRestTask.h.

◆ fMode

REST_TASKMODE TRestTask::fMode

protected

Definition at line 32 of file TRestTask.h.

◆ fNRequiredArgument

unsigned int TRestTask::fNRequiredArgument

protected

Definition at line 31 of file TRestTask.h.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ TRestTask() [1/2]

◆ TRestTask() [2/2]

◆ ~TRestTask()

Member Function Documentation

◆ GetMode()

◆ GetTaskFromCommand()

◆ GetTaskFromMacro()

◆ InitFromConfigFile()

◆ PrintArgumentHelp()

◆ RunTask()

◆ SetArgumentValue()

◆ SetMode()

Field Documentation

◆ fArgumentNames

◆ fArgumentTypes

◆ fArgumentValues

◆ fConstructedCommand

◆ fInvokeMethod

◆ fInvokeObject

◆ fMode

◆ fNRequiredArgument