OptionList Struct Reference

Classes
struct	Link

Public Member Functions
	OptionList ()
	OptionList (const OptionList &other)
	~OptionList ()
void	Delete ()
OptionList &	operator= (const OptionList &other)
void	SetDescription (const TString &d)
void	Copy (const OptionList &other)
void	DebugLink (const Link *link) const
Option *	Find (const TString &name) const
Option *	Add (const TString &name, const TString &arg, const TString &desc, const TString &val="")
Option *	Add (const TString &name, const TString &desc)
Option *	Add (const TString &name, const TString &desc, Bool_t def)
Option *	Add (const TString &name, const TString &arg, const TString &desc, Int_t val, Bool_t asHex=false)
Option *	Add (const TString &name, const TString &arg, const TString &desc, Long64_t val, Bool_t asHex=false)
Option *	Add (const TString &name, const TString &arg, const TString &desc, Double_t val)
void	Remove (const TString &name)
Bool_t	Has (const TString &name) const
const TString &	Get (const TString &name) const
Bool_t	GetF (const TString &name, const Char_t *format,...) const
Bool_t	AsBool (const TString &name) const
Int_t	AsInt (const TString &name, Int_t def=0) const
Long64_t	AsLong (const TString &name, Long64_t def=0) const
Double_t	AsDouble (const TString &name, Double_t def=0) const
const char *	AsString (const TString &name, const TString &def="") const
const TString &	AsTString (const TString &name, const TString &def="") const
void	SetF (const TString &name, const Char_t *format,...)
void	Set (const TString &name, const TString &value)
void	Set (const TString &name)
void	Set (const TString &name, Int_t val, Bool_t asHex=false)
void	Set (const TString &name, Long64_t val, Bool_t asHex=false)
void	Set (const TString &name, Double_t val)
Bool_t	Parse (const TString &tmp, const TString &delims)
Bool_t	Parse (const TCollection *opts, Bool_t ignoreUnknown=false)
void	Widest (Int_t &nWidth, Int_t &aWidth) const
void	HelpDesc (std::ostream &o, const TString &prefix="", const Int_t max=70) const
void	Help (std::ostream &o, const char *prefix=" ") const
void	Show (std::ostream &o, const char *prefix=" ") const
void	Store (std::ostream &o, const char *prefix="", const char *delim=",", bool quote=true, bool onlySet=false) const

Static Public Member Functions
static void	Test (const char *opts="")

Public Attributes
Link *	fList
TString	fDesc

Detailed Description

A List of options

Definition at line 263 of file Option.C.

Constructor & Destructor Documentation

OptionList::OptionList ( )

inline

Constructor

Definition at line 303 of file Option.C.

OptionList::OptionList ( const OptionList &  other )

inline

Copy constructor

Parameters

other

Object to copy from

Definition at line 309 of file Option.C.

OptionList::~OptionList ( )

inline

Destructor

Definition at line 322 of file Option.C.

Member Function Documentation

Option* OptionList::Add ( const TString &  name, const TString &  arg, const TString &  desc, const TString &  val = ""  )

inline

Add an option with argument

Parameters

name	Name of option
arg	Dummy argument
desc	Description
val	Default value

Returns

Newly added option

Definition at line 421 of file Option.C.

Referenced by AAFPluginRailway::AAFPluginRailway(), AAFRailway::AAFRailway(), Add(), AODTrain::AODTrain(), BothAODTrain::BothAODTrain(), BothdNdetaTrain::BothdNdetaTrain(), ELossTimeTrain::ELossTimeTrain(), GridRailway::GridRailway(), LiteRailway::LiteRailway(), LocalRailway::LocalRailway(), MakeAODTrain::MakeAODTrain(), MakedNdetaTrain::MakedNdetaTrain(), MakeFlowTrain::MakeFlowTrain(), MakeFMDELossTrain::MakeFMDELossTrain(), MakeFMDMCHitTrain::MakeFMDMCHitTrain(), MakeFMDMCTrackTrain::MakeFMDMCTrackTrain(), MakeFullTrain::MakeFullTrain(), MakeMCCorrTrain::MakeMCCorrTrain(), MakeMultDistsTrain::MakeMultDistsTrain(), MakeMultTrain::MakeMultTrain(), MakeQATrain::MakeQATrain(), MakeRespMatrTrain::MakeRespMatrTrain(), MakeTrackletTrain::MakeTrackletTrain(), MakeTriggerBiasTrain::MakeTriggerBiasTrain(), PluginRailway::PluginRailway(), ProofRailway::ProofRailway(), Railway::Railway(), Test(), TrackletAODdNdeta::TrackletAODdNdeta(), TrackletAODTrain::TrackletAODTrain(), TrackletdNdetaTrain::TrackletdNdetaTrain(), TrainSetup::TrainSetup(), and VAFRailway::VAFRailway().

Option* OptionList::Add ( const TString &  name, const TString &  desc  )

inline

Add an option with no argument

Parameters

name	Name of option
desc	Description

Returns

Newly created option

Definition at line 473 of file Option.C.

Option* OptionList::Add ( const TString &  name, const TString &  desc, Bool_t  def  )

inline

Add an option with no argument

Parameters

name	Name of option
desc	Description
def	Default value (true, or false)

Returns

Newly created option

Definition at line 487 of file Option.C.

Option* OptionList::Add ( const TString &  name, const TString &  arg, const TString &  desc, Int_t  val, Bool_t  asHex = false  )

inline

Add an option with argument

Parameters

name	Name of option
arg	Dummy argument
desc	Description
val	Default value
asHex	If true, interpret as hex number

Returns

Newly added option

Definition at line 506 of file Option.C.

Option* OptionList::Add ( const TString &  name, const TString &  arg, const TString &  desc, Long64_t  val, Bool_t  asHex = false  )

inline

Add an option with argument

Parameters

name	Name of option
arg	Dummy argument
desc	Description
val	Default value
asHex	If true, interpret as hex

Returns

Newly added option

Definition at line 529 of file Option.C.

Option* OptionList::Add ( const TString &  name, const TString &  arg, const TString &  desc, Double_t  val  )

inline

Add an option with argument

Parameters

name	Name of option
arg	Dummy argument
desc	Description
val	Default value

Returns

Newly added option

Definition at line 551 of file Option.C.

Bool_t OptionList::AsBool ( const TString &  name ) const

inline

Get value of an option as a boolean

Parameters

name

Name of

Returns

Value or false if not found

Definition at line 631 of file Option.C.

Referenced by MakeFlowTrain::AddEPTasks(), MakeFlowTrain::AddQCTasks(), MakeFullTrain::CreateAODTasks(), TrackletAODdNdeta::CreateCentralitySelection(), TrainSetup::CreateCentralitySelection(), MakeFullTrain::CreateFlowTasks(), TrackletAODTrain::CreateInputHandler(), BothAODTrain::CreateInputHandler(), MakeTrackletTrain::CreateInputHandler(), TrainSetup::CreateInputHandler(), TrackletdNdetaTrain::CreateTask(), MakeFMDMCHitTrain::CreateTasks(), MakeFMDMCTrackTrain::CreateTasks(), MakeMCCorrTrain::CreateTasks(), MakeMultDistsTrain::CreateTasks(), MakeFMDELossTrain::CreateTasks(), MakeFlowTrain::CreateTasks(), TrainSetup::FromOption(), and TrainSetup::Init().

Double_t OptionList::AsDouble ( const TString &  name, Double_t  def = 0  ) const

inline

Return value of an option as a double precision real number

Parameters

name	Name of option
def	Default value if options isn't found

Returns

Value or default value

Definition at line 673 of file Option.C.

Referenced by MakeFlowTrain::AddQCTasks(), MakedNdetaTrain::CoupledNdetaCar(), BothdNdetaTrain::CoupledNdetaCar(), BothAODTrain::CoupleForwardCar(), MakeFullTrain::CreateFlowTasks(), MakeTrackletTrain::CreateTask(), MakeMultDistsTrain::CreateTasks(), MakeFMDELossTrain::CreateTasks(), MakeAODTrain::CreateTasks(), and TrainSetup::FromOption().

Int_t OptionList::AsInt ( const TString &  name, Int_t  def = 0  ) const

inline

Return value of an option as an integer

Parameters

name	Name of option
def	Default value if options isn't found

Returns

Value or default value

Definition at line 645 of file Option.C.

Referenced by MakeFlowTrain::AddEPTasks(), MakeFlowTrain::AddQCTasks(), TrainSetup::AddTender(), BothAODTrain::CoupleClusterCar(), BothAODTrain::CoupleForwardCar(), MakeFullTrain::CreateAODTasks(), MakeFullTrain::CreateFlowTasks(), MakeFMDMCHitTrain::CreateTasks(), MakeFMDMCTrackTrain::CreateTasks(), MakeMCCorrTrain::CreateTasks(), AODTrain::CreateTasks(), MakeAODTrain::CreateTasks(), TrainSetup::FromOption(), TrainSetup::Init(), GridRailway::PostSetup(), MakeAODTrain::SavedNdeta(), and BothAODTrain::SavedNdeta().

Long64_t OptionList::AsLong ( const TString &  name, Long64_t  def = 0  ) const

inline

Return value of an option as an integer

Parameters

name	Name of option
def	Default value if options isn't found

Returns

Value or default value

Definition at line 659 of file Option.C.

Referenced by TrainSetup::FromOption(), LiteRailway::Run(), TrainSetup::Run(), and ProofRailway::Run().

const char* OptionList::AsString ( const TString &  name, const TString &  def = ""  ) const

inline

return value of an option as a string

Parameters

name	Name of option
def	Default valie if option isn't found

Returns

Value or default value

Definition at line 687 of file Option.C.

Referenced by TrackletdNdetaTrain::CoupleTrackletCar(), TrackletAODTrain::CoupleTrackletCar(), BothdNdetaTrain::CoupleTrackletCar(), BothAODTrain::CoupleTrackletCar(), TrainSetup::CreateCentralitySelection(), TrackletdNdetaTrain::CreateInputHandler(), MakeTrackletTrain::CreateTask(), MakeMCCorrTrain::CreateTasks(), MakeMultDistsTrain::CreateTasks(), TrackletAODTrain::CreateTasks(), TrackletAODdNdeta::CreateTasks(), TrainSetup::FromOption(), Railway::LocalChain(), TrackletdNdetaTrain::SetupReweighting(), and MakeTrackletTrain::SetupReweighting().

const TString& OptionList::AsTString ( const TString &  name, const TString &  def = ""  ) const

inline

return value of an option as a string

Parameters

name	Name of option
def	Default valie if option isn't found

Returns

Value or default value

Definition at line 701 of file Option.C.

void OptionList::Copy ( const OptionList &  other )

inline

Copy list from other object

Parameters

other

Object to copy from

Definition at line 365 of file Option.C.

Referenced by operator=(), and OptionList().

void OptionList::DebugLink ( const Link *  link ) const

inline

Definition at line 382 of file Option.C.

void OptionList::Delete ( )

inline

Remove all options

Definition at line 327 of file Option.C.

Referenced by Copy(), operator=(), and ~OptionList().

Option* OptionList::Find ( const TString &  name ) const

inline

Find an optio by name

Parameters

name	Name of option to find

Returns

Pointer to option or null

Definition at line 401 of file Option.C.

Referenced by Add(), AsBool(), AsDouble(), AsInt(), AsLong(), AsString(), AsTString(), Get(), GetF(), Has(), Parse(), GridRailway::RegisterRuns(), TrainSetup::SaveSetup(), Set(), SetF(), and Test().

const TString& OptionList::Get ( const TString &  name ) const

inline

Get the value of an option

Parameters

name	Name of option

Returns

Value of option, or empty string

Definition at line 596 of file Option.C.

Referenced by MakeFlowTrain::AddEPTasks(), GridRailway::AddFiles(), MakeFlowTrain::AddQCTasks(), TrainSetup::AddTender(), AAFRailway::AliPhysicsParName(), AAFRailway::AliROOTParName(), BothAODTrain::CoupleClusterCar(), BothAODTrain::CoupleForwardCar(), TrackletAODTrain::CouplePreCars(), BothAODTrain::CouplePreCars(), TrackletdNdetaTrain::CoupleTrackletCar(), BothdNdetaTrain::CoupleTrackletCar(), ProofRailway::CreateAliROOTPar(), MakeFullTrain::CreateAODTasks(), MakeFullTrain::CreatedNdetaTask(), MakeFullTrain::CreateFlowTasks(), TrainSetup::CreateInputHandler(), TrainSetup::CreatePhysicsSelection(), TrackletdNdetaTrain::CreateTask(), MakeTrackletTrain::CreateTask(), ELossTimeTrain::CreateTasks(), MakeQATrain::CreateTasks(), MakeFMDELossTrain::CreateTasks(), MakeAODTrain::CreateTasks(), MakedNdetaTrain::CreateTasks(), TrackletAODTrain::CreateTasks(), TrackletAODdNdeta::CreateTasks(), BothdNdetaTrain::CreateTasks(), ProofRailway::EnableSpecial(), VAFRailway::GetDataSet(), TrainSetup::Help(), TrainSetup::Init(), Railway::InputType(), GridRailway::Operation(), AAFPluginRailway::PostSetup(), GridRailway::PostSetup(), PluginRailway::PostSetup(), ProofRailway::PostSetup(), AAFPluginRailway::PreSetup(), AAFRailway::PreSetup(), PluginRailway::PreSetup(), ProofRailway::PreSetup(), GridRailway::RegisterRuns(), TrainSetup::Run(), ProofRailway::Run(), TrainSetup::SaveSetupROOT(), TrainSetup::SaveSetupShell(), and GridRailway::ScanFiles().

Bool_t OptionList::GetF ( const TString &  name, const Char_t *  format,   ...  ) const

inline

Get a value using a format statement. Remember argument(s) must be passed by address (as pointers)

Parameters

name	Name of option
format	Format statement. Remeber, double and long needs the "l" modifier

Returns

true on success

Definition at line 612 of file Option.C.

Referenced by Test().

Bool_t OptionList::Has ( const TString &  name ) const

inline

Check if a given option was set externally

Parameters

name	Name of option

Returns

true if option exists and was set externally

Definition at line 584 of file Option.C.

Referenced by GridRailway::AuxSave(), BothAODTrain::CoupleClusterCar(), BothAODTrain::CoupleForwardCar(), TrackletAODTrain::CouplePostCars(), BothAODTrain::CouplePostCars(), TrackletAODTrain::CouplePreCars(), BothAODTrain::CouplePreCars(), TrackletdNdetaTrain::CoupleTrackletCar(), BothdNdetaTrain::CoupleTrackletCar(), MakeFullTrain::CreateAODTasks(), MakeTestADTrain::CreateCentralitySelection(), MakeQATrain::CreateCentralitySelection(), MakeFMDELossTrain::CreateCentralitySelection(), TrackletAODdNdeta::CreateCentralitySelection(), MakeAODTrain::CreateCentralitySelection(), TrackletAODTrain::CreateCentralitySelection(), AODTrain::CreateCentralitySelection(), BothAODTrain::CreateCentralitySelection(), TrainSetup::CreateCentralitySelection(), MakeFullTrain::CreateFlowTasks(), AODTrain::CreateMCHandler(), AODTrain::CreatePhysicsSelection(), MakeQATrain::CreateTasks(), MakeMCCorrTrain::CreateTasks(), MakeFMDELossTrain::CreateTasks(), AODTrain::CreateTasks(), MakeAODTrain::CreateTasks(), MakedNdetaTrain::CreateTasks(), TrackletAODdNdeta::CreateTasks(), BothdNdetaTrain::CreateTasks(), MakeFullTrain::CreateTasks(), ProofRailway::EnableSpecial(), TrainSetup::Help(), TrainSetup::Init(), Railway::InputType(), Railway::IsMC(), Railway::LocalChain(), GridRailway::Operation(), ProofRailway::OutputPath(), AAFPluginRailway::PostSetup(), GridRailway::PostSetup(), PluginRailway::PostSetup(), ProofRailway::PostSetup(), AAFPluginRailway::PreSetup(), AAFRailway::PreSetup(), VAFRailway::PreSetup(), PluginRailway::PreSetup(), ProofRailway::PreSetup(), TrainSetup::Run(), MakeMCCorrTrain::SaveDraw(), TrainSetup::SetupWorkingDirectory(), and TrainSetup::Version().

void OptionList::Help ( std::ostream &  o, const char *  prefix = "  "  ) const

inline

Display option help

Parameters

o	Output stream
prefix	Prefix for each option.

Definition at line 903 of file Option.C.

Referenced by TrainSetup::Help(), TrainSetup::SaveSetupROOT(), TrainSetup::SaveSetupShell(), and Railway::ShowFullHelp().

void OptionList::HelpDesc ( std::ostream &  o, const TString &  prefix = "", const Int_t  max = 70  ) const

inline

Definition at line 867 of file Option.C.

Referenced by Help().

OptionList& OptionList::operator= ( const OptionList &  other )

inline

Assignment operator

Parameters

other

Object to assign from

Returns

reference to this

Definition at line 346 of file Option.C.

Bool_t OptionList::Parse ( const TString &  tmp, const TString &  delims  )

inline

Parse the options given in tmp

Parameters

tmp	String to pass
delims	Delimiters

Returns

true on success

Definition at line 796 of file Option.C.

Referenced by Railway::ParseOptions(), and Test().

Bool_t OptionList::Parse ( const TCollection *  opts, Bool_t  ignoreUnknown = false  )

inline

Parse options given in a collection

Parameters

opts	List of arguments
ignoreUnknown	If true, ignore unknown options

Returns

true on success

Definition at line 812 of file Option.C.

void OptionList::Remove ( const TString &  name )

inline

Remove an option

Parameters

name	Name of option to remove

Definition at line 564 of file Option.C.

Referenced by LiteRailway::LiteRailway(), TrainSetup::SaveSetupROOT(), and Test().

void OptionList::Set ( const TString &  name, const TString &  value  )

inline

Set an option

Parameters

name	Name of option
value	Value of option

Definition at line 736 of file Option.C.

Referenced by AODTrain::AODTrain(), BothAODTrain::BothAODTrain(), MakeTrackletTrain::CreateTask(), ELossTimeTrain::ELossTimeTrain(), EventTimeTrain::EventTimeTrain(), VAFRailway::LoadAliROOT(), MakeAODTrain::MakeAODTrain(), MakeFlowTrain::MakeFlowTrain(), MakeFMDELossTrain::MakeFMDELossTrain(), MakeFMDEventPlaneTrain::MakeFMDEventPlaneTrain(), MakeFMDMCHitTrain::MakeFMDMCHitTrain(), MakeFMDMCTrackTrain::MakeFMDMCTrackTrain(), MakeFullTrain::MakeFullTrain(), MakeMCCorrTrain::MakeMCCorrTrain(), MakeMultClassTrain::MakeMultClassTrain(), MakeQATrain::MakeQATrain(), MakeTestADTrain::MakeTestADTrain(), MyTrain::MyTrain(), AAFRailway::PreSetup(), PluginRailway::PreSetup(), TrainSetup::SaveSetup(), TrainSetup::SaveSetupShell(), Set(), Test(), TrackletAODdNdeta::TrackletAODdNdeta(), and TrackletAODTrain::TrackletAODTrain().

void OptionList::Set ( const TString &  name )

inline

Set a flag

Parameters

name	Name of flag

Definition at line 747 of file Option.C.

void OptionList::Set ( const TString &  name, Int_t  val, Bool_t  asHex = false  )

inline

Set long integer value

Parameters

name	Name of option
val	Value
asHex	If true, interpret as hex

Definition at line 760 of file Option.C.

void OptionList::Set ( const TString &  name, Long64_t  val, Bool_t  asHex = false  )

inline

Set long integer value

Parameters

name	Name of option
val	Value
asHex	If true, interpret as hex value

Definition at line 772 of file Option.C.

void OptionList::Set ( const TString &  name, Double_t  val  )

inline

Set double precision floating point value

Parameters

name	Name of option
val	Value

Definition at line 784 of file Option.C.

void OptionList::SetDescription ( const TString &  d )

inline

Set the description

Parameters

d	Description

Definition at line 359 of file Option.C.

Referenced by MakeTrackletTrain::MakeTrackletTrain(), TrackletAODdNdeta::TrackletAODdNdeta(), TrackletAODTrain::TrackletAODTrain(), and TrackletdNdetaTrain::TrackletdNdetaTrain().

void OptionList::SetF ( const TString &  name, const Char_t *  format,   ...  )

inline

Set value using a format statement

Parameters

name	Name of option.
format	Format statement

Definition at line 715 of file Option.C.

Referenced by Test().

void OptionList::Show ( std::ostream &  o, const char *  prefix = "  "  ) const

inline

Show the values of options

Parameters

o	Output stream
prefix	Prefix for each option

Definition at line 928 of file Option.C.

Referenced by Railway::LocalChain(), MakeFlowTrain::MakeFlowTrain(), MakeFullTrain::MakeFullTrain(), TrainSetup::Print(), Railway::Print(), and Test().

void OptionList::Store ( std::ostream &  o, const char *  prefix = "", const char *  delim = ",", bool  quote = true, bool  onlySet = false  ) const

inline

Show the values of options

Parameters

o	Output stream
prefix	Prefix for each option
delim	Delimters
quote	Quote output
onlySet	if true, only output set options

Definition at line 951 of file Option.C.

Referenced by TrainSetup::SaveSetupROOT(), and TrainSetup::SaveSetupShell().

static void OptionList::Test ( const char *  opts = "" )

inlinestatic

Definition at line 975 of file Option.C.

void OptionList::Widest ( Int_t &  nWidth, Int_t &  aWidth  ) const

inline

Find the widest name and dummy argument

Parameters

nWidth	On return, the largest width of option names
aWidth	On return, the largest width of option dummy args

Definition at line 852 of file Option.C.

Referenced by Help(), Show(), and Store().

Member Data Documentation

TString OptionList::fDesc

Definition at line 973 of file Option.C.

Referenced by HelpDesc(), and SetDescription().

Link* OptionList::fList

Definition at line 972 of file Option.C.

Referenced by Add(), Copy(), Delete(), Find(), Help(), Remove(), Show(), Store(), and Widest().

---

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

• PWGLF/FORWARD/trains/Option.C