AAObject Struct Reference

AAObject is a base class for I/O-classes that adds the possibility to add 'user' information which will also be stored in the ROOT file. More...

#include <AAObject.hh>

Inheritance diagram for AAObject:

Public Member Functions
int	idx (const std::string &key) const
	Get index in user data of the item with given key.
bool	haveusr (const std::string &key) const
	Check availability of user data of the item with given key.
int	idxusr_checked (const std::string &key) const
	Get index in user data of the item with given key.
double	getusr (const std::string &key) const
	Get user data item with given key.
void	setusr (const std::string &key, double value)
	Set user data item with given key.
bool	delusr (const std::string &key)
	Remove (first) user data item with given key.
void	clearusr ()
	Clear user data.
void	printusr (std::ostream &out=std::cout)
	Print user data (i.e.
	AAObject ()
	Default constructor.
	~AAObject ()

Public Attributes
std::vector< double >	usr
	user data
std::vector< std::string >	usr_names
	user keys
TObject *	any
	Pointer to "any" user data.

Detailed Description

AAObject is a base class for I/O-classes that adds the possibility to add 'user' information which will also be stored in the ROOT file.

Definition at line 18 of file AAObject.hh.

Constructor & Destructor Documentation

AAObject()

AAObject::AAObject ( )

inline

Default constructor.

Definition at line 167 of file AAObject.hh.

: any(NULL) {}

~AAObject()

AAObject::~AAObject ( )

inline

Definition at line 168 of file AAObject.hh.

{}

Member Function Documentation

idx()

int AAObject::idx ( const std::string & key ) const

inline

Get index in user data of the item with given key.

Parameters

key

key

Returns

index (-1 if key does not exists)

Definition at line 29 of file AAObject.hh.

  {
    auto i = std::find (usr_names.begin(), usr_names.end(), key );
    if (i == usr_names.end()) return -1;
    return i - usr_names.begin();
  }

haveusr()

bool AAObject::haveusr ( const std::string & key ) const

inline

Check availability of user data of the item with given key.

Parameters

key

key

Returns

true if available; else false

Definition at line 42 of file AAObject.hh.

  {
    return idx( key ) >= 0;
  }

idxusr_checked()

int AAObject::idxusr_checked ( const std::string & key ) const

inline

Get index in user data of the item with given key.

This method throws a run-time exception if no user data are available.

Parameters

key

key

Returns

index (-1 if key does not exists)

Definition at line 54 of file AAObject.hh.

  {
    int r = idx( key );
    if (r < 0)
    {
      THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
    }
    return r;
  }

getusr()

double AAObject::getusr ( const std::string & key ) const

inline

Get user data item with given key.

This method throws a run-time exception if no user data are available.

Parameters

key

key

Returns

value

Definition at line 72 of file AAObject.hh.

  {
    const int i = idx( key );
 
    if ( i  < 0 )
    {
      THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
    }
 
    if ( unsigned(i) >= usr.size() )
    {
      THROW(Exception, "Warning: inconsistent user data " << i << " >= " << usr.size());
    }
 
    return usr[i];
  }

setusr()

void AAObject::setusr ( const std::string & key, double value )

inline

Set user data item with given key.

Parameters

key	key
value	value

Definition at line 95 of file AAObject.hh.

  {
    int i = idx( key );
    if (i < 0)
    {
      if ( usr.size() < usr_names.size() )
      {
        // this should not happen, but let's just add empty data
        usr.resize( usr_names.size() );
      }
      else
      {
        // this is possible, add empty ("") names
        usr_names.resize( usr.size() );
      }
 
      usr_names.push_back( key );
      usr.push_back( value );
    }
    else
    {
      usr[i] = value;
    }
  }

delusr()

bool AAObject::delusr ( const std::string & key )

inline

Remove (first) user data item with given key.

Parameters

key

key

Returns

true if data have been removed; else false

Definition at line 126 of file AAObject.hh.

  {
    int i = idx( key );
    if ( i < 0 ) return false;
 
    usr.erase ( usr.begin() + i );
    usr_names.erase( usr_names.begin() + i );
    return true;
  }

clearusr()

void AAObject::clearusr ( )

inline

Clear user data.

Definition at line 139 of file AAObject.hh.

  {
    usr.resize(0);
    usr_names.resize(0);
  }

printusr()

void AAObject::printusr ( std::ostream & out = std::cout )

inline

Print user data (i.e.

list of all pairs of keys and values).

Parameters

out	output stream

Definition at line 150 of file AAObject.hh.

  {
    unsigned n = std::max( usr.size(), usr_names.size() );
 
    for (unsigned i = 0; i < n ; i++)
    {
      std::string name = "(unnamed)";
      if ( i < usr_names.size() && usr_names[i] != "" ) name = usr_names[i];
      out << i << " \t " << name << " : \t ";
      if ( i < usr.size() ) out << usr[i] << std::endl;
      else                  out << "(none)" << std::endl;
    }
  }

Member Data Documentation

usr

std::vector<double> AAObject::usr

user data

Definition at line 20 of file AAObject.hh.

usr_names

std::vector<std::string> AAObject::usr_names

user keys

Definition at line 21 of file AAObject.hh.

any

TObject* AAObject::any

Pointer to "any" user data.

Definition at line 171 of file AAObject.hh.

---

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

• AAObject.hh