DocString Class Reference

#include <DocString.hxx>

Inheritance diagram for DocString:

Public Member Functions
	DocString ()
	Empty constructor to keep ROOT happy when reading in from TClonesArray.
	DocString (const std::string &tree, const std::string &name, const std::string &doc, const std::string &type, int size1, const std::string &counter1, int size2, const std::string &counter2, int size3, const std::string &counter3)
	Constructor that actually sets the information.
virtual	~DocString ()
	Destructor.
void	Explain ()
std::string	Name ()
	Get the name of this variable.
std::string	Tree ()
	Get the name of the tree this variable was stored in.
	ClassDef (DocString, 1)

Protected Attributes
std::string	_tree
	The name of the tree this variable was stored in.
std::string	_name
	The name of this variable.
std::string	_doc
	The documentation string provided by the user.
std::string	_type
	The type of this variable (I/F/C/D)
std::string	_counter1
	If a vector, the counter used for the 1st dimension.
std::string	_counter2
	If a matrix, the counter used for the 2nd dimension.
std::string	_counter3
	If a 3D matrix, the counter used for the 3rd dimension.
int	_size1
	If a vector, the size of the 1st dimension.
int	_size2
	If a matrix, the size of the 2nd dimension.
int	_size3
	If a 3D matrix, the size of the 3rd dimension.

Detailed Description

This class is used to store information about the variables stored in the micro-trees. The DocStringManager is used to create, store and access DocString objects.

Each variable stored in the micro-trees has an associated DocString object, which records the name, type, size and other information about the variable.

This DocString class should not need to be accessed by users. All the functionality is handled automatically.

Definition at line 16 of file DocString.hxx.

Member Function Documentation

Explain()

void DocString::Explain

(

)

Print out the details of this variable. If it is a track category variable, also print out the track categories.

Definition at line 29 of file DocString.cxx.

                        {
  std::string dim = "Unknown";
  std::string nicetype = "Unknown";

  if (_size3 != 0) {
    dim = "3D matrix of ";
  } else if (_size2 != 0) {
    dim = "Matrix of ";
  } else if (_size1 != 0) {
    dim = "Vector of ";
  } else {
    dim = "";
  }

  if (_type == "F") {
    nicetype = "float";
  } else if (_type == "D") {
    nicetype = "double";
  } else if (_type == "I") {
    nicetype = "integer";
  } else if (_type == "C") {
    nicetype = "char";
  }

  std::cout << "Variable name..... " << _name << std::endl;
  std::cout << "Stored in tree.... " << _tree << std::endl;
  std::cout << "Type of variable.. " << dim << nicetype << std::endl;
  if (_size1 != 0) {
    std::cout << "Size of variable: " << std::endl;
    std::cout << "  1st dimension... ";
    if (_size1>0) {
      std::cout << abs(_size1) << " (fixed size)" << std::endl;
    } else {
      std::cout << _counter1 << " (variable size, up to a maximum of " << abs(_size1) << ")" << std::endl;
    }
    if (_size2 != 0) {
      std::cout << "  2nd dimension... ";
      if (_size2>0) {
        std::cout << abs(_size2) << " (fixed size)" << std::endl;
      } else {
        std::cout << _counter2 << " (variable size, up to a maximum of " << abs(_size2) << ")" << std::endl;
      }
      if (_size3 != 0) {
        std::cout << "  3rd dimension... ";
        if (_size3>0) {
          std::cout << abs(_size3) << " (fixed size)" << std::endl;
        } else {
          std::cout << _counter3 << " (variable size, up to a maximum of " << abs(_size3) << ")" << std::endl;
        }
      }
    }
  }
  std::cout << "Documentation..... " << _doc << std::endl;

  //  if (ND::categ().HasCategory(_name)) {
  //    ND::categ().DumpTrackCategory(_name);
  //  }
}

---

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

• /hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/DocString.hxx
• /hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/DocString.cxx