Auxiliary class to handle file name, ROOT directory and object name. More...

#include <JRootObjectID.hh>

Public Member Functions
	JRootObjectID ()
	Default constructor.

	JRootObjectID (const std::string &file_name, const std::string &name)
	Constructor.

	JRootObjectID (const std::string &file_name, const std::string &dir, const std::string &name)
	Constructor.

	JRootObjectID (const std::string &full_name)
	Constructor.

const std::string &	getFilename () const
	Get file name.

TString	getDirectory () const
	Get directory.

TString	getObjectName () const
	Get object name.

TString	getFullFilename () const
	Get full file name, including path.

TString	getFullObjectName () const
	Get full object name, including path.

bool	is_valid () const
	Check validity.

void	clear ()
	Clear.

Static Public Attributes
static const char	LABEL_L_BRACKET = '['
	left bracket for label

static const char	LABEL_R_BRACKET = ']'
	right bracket for label

static const char	FILENAME_SEPARATOR = ':'
	file name separator

static const char	PATHNAME_SEPARATOR = '/'
	path name separator

Protected Attributes
std::string	file_name

std::string	directory

std::string	name

Friends
bool	operator== (const JRootObjectID &first, const JRootObjectID &second)
	Equal operator for object identifiers.

std::istream &	operator>> (std::istream &in, JRootObjectID &object)
	Read object identifier from input.

std::ostream &	operator<< (std::ostream &out, const JRootObjectID &object)
	Write object identifier to output.

Detailed Description

Auxiliary class to handle file name, ROOT directory and object name.

The general syntax is as follows:

  <file name>:[<directory/>]<object name>

where <directory> is optional and <object name> may be a regular expression (TRegexp).

Definition at line 36 of file JRootObjectID.hh.

Constructor & Destructor Documentation

◆ JRootObjectID() [1/4]

JGIZMO::JRootObjectID::JRootObjectID ( )

inline

Default constructor.

Definition at line 49 of file JRootObjectID.hh.

50 {}

◆ JRootObjectID() [2/4]

JGIZMO::JRootObjectID::JRootObjectID	(	const std::string &	file_name,
		const std::string &	name )

inline

Constructor.

Parameters

file_name	file name
name	object name

Definition at line 59 of file JRootObjectID.hh.

                                         :
      file_name(file_name),
      directory(""),
      name     (name)
    {}

◆ JRootObjectID() [3/4]

JGIZMO::JRootObjectID::JRootObjectID	(	const std::string &	file_name,
		const std::string &	dir,
		const std::string &	name )

inline

Constructor.

Parameters

file_name	file name
dir	directory name
name	object name

Definition at line 74 of file JRootObjectID.hh.

                                         :
      file_name(file_name),
      directory(dir),
      name     (name)
    {}

◆ JRootObjectID() [4/4]

JGIZMO::JRootObjectID::JRootObjectID ( const std::string & full_name )

inline

Constructor.

Parameters

full_name full object name

Definition at line 88 of file JRootObjectID.hh.

    {
      std::istringstream(full_name) >> *this;
    }

Member Function Documentation

◆ getFilename()

const std::string & JGIZMO::JRootObjectID::getFilename ( ) const

inline

Get file name.

Returns: file name

Definition at line 99 of file JRootObjectID.hh.

    {
      return file_name;
    }

◆ getDirectory()

TString JGIZMO::JRootObjectID::getDirectory ( ) const

inline

Get directory.

Returns: directory

Definition at line 110 of file JRootObjectID.hh.

    {
      return TString(directory.c_str());
    }

◆ getObjectName()

TString JGIZMO::JRootObjectID::getObjectName ( ) const

inline

Get object name.

Returns: object name

Definition at line 121 of file JRootObjectID.hh.

    {
      return TString(name.c_str());
    }

◆ getFullFilename()

TString JGIZMO::JRootObjectID::getFullFilename ( ) const

inline

Get full file name, including path.

Returns: file name

Definition at line 132 of file JRootObjectID.hh.

    {
      if (getDirectory() == "")
        return getFilename();
      else
        return getFilename() + PATHNAME_SEPARATOR + getDirectory();
    }

◆ getFullObjectName()

TString JGIZMO::JRootObjectID::getFullObjectName ( ) const

inline

Get full object name, including path.

Returns: object name

Definition at line 146 of file JRootObjectID.hh.

    {
      if (getDirectory() == "")
        return getObjectName();
      else
        return getDirectory() + PATHNAME_SEPARATOR + getObjectName();
    }

◆ is_valid()

bool JGIZMO::JRootObjectID::is_valid ( ) const

inline

Check validity.

Returns: true if valid ROOT object identifier; else false

Definition at line 160 of file JRootObjectID.hh.

    {
      return (file_name != "" &&
              name      != "");
    }

◆ clear()

void JGIZMO::JRootObjectID::clear ( )

inline

Clear.

Definition at line 169 of file JRootObjectID.hh.

    {
      file_name.clear();
      directory.clear();
      name     .clear();
    }

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const JRootObjectID &	first,
		const JRootObjectID &	second )

friend

Equal operator for object identifiers.

Parameters

first	first object identifier
second	second object identifier

Returns: true if first and second object identifier are equal; else false

Definition at line 184 of file JRootObjectID.hh.

    {
      return (first.getFilename()   == second.getFilename()  &&
              first.getDirectory()  == second.getDirectory() &&
              first.getObjectName() == second.getObjectName());
    }

◆ operator>>

std::istream & operator>>	(	std::istream &	in,
		JRootObjectID &	object )

friend

Read object identifier from input.

Parameters

in	input stream
object	object identifier

Returns: input stream

Definition at line 199 of file JRootObjectID.hh.

    {
      using namespace std;
 
      object.clear();
 
      string buffer;
 
      for (int bracket = 0; in.peek() != EOF; ) {
 
        const char c = (char) in.get();
 
        if        (c == LABEL_L_BRACKET) {
 
          ++bracket;
 
        } else if (c == LABEL_R_BRACKET) {
 
          --bracket;
 
        } else if (isspace(c)) {
 
          if (bracket <= 0) {
            break;
          }
        }
 
        buffer.push_back(c);
      }
 
      size_t pos = buffer.find(FILENAME_SEPARATOR);
 
      if (pos != string::npos) {
 
        object.file_name = buffer.substr(0, pos);
        object.name      = buffer.substr(pos + 1);
 
        pos = object.name.rfind(PATHNAME_SEPARATOR);
 
        if (pos != string::npos) {
          
          object.directory = object.name.substr(0, pos);
          object.name      = object.name.substr(pos + 1);
        }
 
      } else if (!buffer.empty()) {
 
        throw JParseError("JRootObjectID error parsing " + buffer);
      }
 
      return in;
    }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const JRootObjectID &	object )

friend

Write object identifier to output.

Parameters

out	output stream
object	object identifier

Returns: output stream

Definition at line 260 of file JRootObjectID.hh.

    {
      return out << object.getFilename() << FILENAME_SEPARATOR << object.getFullObjectName();
    }

Member Data Documentation

◆ LABEL_L_BRACKET

const char JGIZMO::JRootObjectID::LABEL_L_BRACKET = '['

static

left bracket for label

Definition at line 40 of file JRootObjectID.hh.

◆ LABEL_R_BRACKET

const char JGIZMO::JRootObjectID::LABEL_R_BRACKET = ']'

static

right bracket for label

Definition at line 41 of file JRootObjectID.hh.

◆ FILENAME_SEPARATOR

const char JGIZMO::JRootObjectID::FILENAME_SEPARATOR = ':'

static

file name separator

Definition at line 42 of file JRootObjectID.hh.

◆ PATHNAME_SEPARATOR

const char JGIZMO::JRootObjectID::PATHNAME_SEPARATOR = '/'

static

path name separator

Definition at line 43 of file JRootObjectID.hh.

◆ file_name

std::string JGIZMO::JRootObjectID::file_name

protected

Definition at line 266 of file JRootObjectID.hh.

◆ directory

std::string JGIZMO::JRootObjectID::directory

protected

Definition at line 267 of file JRootObjectID.hh.

◆ name

std::string JGIZMO::JRootObjectID::name

protected

Definition at line 268 of file JRootObjectID.hh.

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

JRootObjectID.hh

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JRootObjectID() [1/4]

◆ JRootObjectID() [2/4]

◆ JRootObjectID() [3/4]

◆ JRootObjectID() [4/4]

Member Function Documentation

◆ getFilename()

◆ getDirectory()

◆ getObjectName()

◆ getFullFilename()

◆ getFullObjectName()

◆ is_valid()

◆ clear()

Friends And Related Symbol Documentation

◆ operator==

◆ operator>>

◆ operator<<

Member Data Documentation

◆ LABEL_L_BRACKET

◆ LABEL_R_BRACKET

◆ FILENAME_SEPARATOR

◆ PATHNAME_SEPARATOR

◆ file_name

◆ directory

◆ name