Changeset 2377 for trunk/MagicSoft/Mars/mbase

Timestamp:

10/04/03 12:47:13 (21 years ago)

Author:

tbretz

Message:

*** empty log message ***

Location:

trunk/MagicSoft/Mars/mbase

Files:

• MArgs.cc (modified) (16 diffs)
• MDirIter.cc (modified) (1 diff)

trunk/MagicSoft/Mars/mbase/MArgs.cc

@@ -28 +28 @@
 // MArgs
 //
+// This is a helper class for executables to parse command line arguments
+//
 //////////////////////////////////////////////////////////////////////////////
 #include "MArgs.h"
@@ -46 +48 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Initializes:
+//  fName: The name of the executable
+//  fArgv: A TList containing all other command line arguments
+//
 MArgs::MArgs(int argc, const char **argv) : fArgc(argc)
 {
@@ -61 +69 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Deletes fArgv.
+//
 MArgs::~MArgs()
 {
@@ -66 +78 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Print all arguments parsed.
+//
 void MArgs::Print(const Option_t *o) const
 {
@@ -72 +88 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the Integer corresponding to the command line argument 'name'
+//  eg. executable -argument 5
+//      GetInt("argument") will return 5
+//
 Int_t MArgs::GetInt(const TString name) const
 {
@@ -77 +99 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the floating point value corresponding to the command line argument
+// 'name'
+//  eg. executable -argument 5.7
+//      GetFloat("argument") will return 5.7
+//
 Double_t MArgs::GetFloat(const TString name) const
 {
@@ -82 +111 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the TString corresponding to the command line argument 'name'
+//  eg. executable -argument=last
+//      GetString("-argument=") will return "last"
+//
 TString MArgs::GetString(const TString name) const
 {
@@ -92 +127 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the Integer corresponding to the command line argument 'name'
+//  eg. executable -argument5
+//      GetIntAndRemove("-argument") will return 5
+// and removes the argument from the internal list.
+//
 Int_t MArgs::GetIntAndRemove(const TString name)
 {
@@ -97 +139 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the floating point value corresponding to the command line argument
+// 'name'
+//  eg. executable -argument5.7
+//      GetFloatAndRemove("-argument") will return 5.7
+// and removes the argument from the internal list.
+//
 Double_t MArgs::GetFloatAndRemove(const TString name)
 {
@@ -102 +152 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the TString corresponding to the command line argument 'name'
+//  eg. executable -argument=last
+//      GetStringAndRemove("-argument=") will return "last"
+// and removes the argument from the internal list.
+//
 TString MArgs::GetStringAndRemove(const TString n)
 {
@@ -118 +175 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the Integer corresponding to the i-th argument. This is ment
+// for enumerations like
+//  executable 1 7 2
+//  GetArgumentInt(1) will return 7
+//
 Int_t MArgs::GetArgumentInt(Int_t i) const
 {
@@ -123 +187 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the floating point value corresponding to the i-th argument.
+// This is ment for enumerations like
+//  executable 1.7 7.5 2.3
+//  GetArgumentFloat(1) will return 7.5
+//
 Float_t MArgs::GetArgumentFloat(Int_t i) const
 {
@@ -128 +199 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Return the TString corresponding to the i-th argument.
+// This is ment for enumerations like
+//  executable file1 file2 file3
+//  GetArgumentStr(1) will return "file2"
+// Only arguments without a trailing '-' are considered
+//
 TString MArgs::GetArgumentStr(Int_t i) const
 {
@@ -146 +225 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// return the number of arguments without a trainling '-'
+//
 Int_t MArgs::GetNumArguments() const
 {
@@ -159 +242 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Checks whether an argument beginning with 'n' is existing, eg:
+//  executable -value5
+//  executable -value
+//  HasOption("-value") will return true in both cases
+//
 Bool_t MArgs::Has(const TString n) const
 {
@@ -171 +261 @@
 }
 
+// --------------------------------------------------------------------------
+//
+// Checks whether an argument beginning with 'n' is exists and a
+// corresponding option is available, eg.
+//  executable -value5
+//  HasOption("-value") will return true
+// but:
+//  executable -value
+//  HasOption("-value") will return false
+//
 Bool_t MArgs::HasOption(const TString n) const
 {

trunk/MagicSoft/Mars/mbase/MDirIter.cc

@@ -179 +179 @@
 }
 
+// --------------------------------------------------------------------------
+//
+//  Returns the concatenation of 'dir' and 'name'
+//
 TString MDirIter::ConcatFileName(const char *dir, const char *name) const
 {