D3PD::ObjectMetadata::Variable Class Reference

Internal class keeping track of a single variable. More...

#include <ObjectMetadata.h>

Collaboration diagram for D3PD::ObjectMetadata::Variable:

Public Member Functions
	Variable ()
	Default constructor. More...
const std::string &	type () const
	Type name of the variable. More...
const std::string &	name () const
	Name of the variable without its prefix. More...
const std::string &	doc () const
	Description of the variable. More...
bool	primitive () const
	Flag showing whether the variable is a primitive. More...
void	setType (const std::string &type)
	Set the type name of the variable. More...
void	setName (const std::string &name)
	Set the name of the variable. More...
void	setDoc (const std::string &doc)
	Set the description of the variable. More...
void	setPrimitive (bool primitive)
	Set whether the variable is a primitive. More...
std::string	toString () const
	Function "serializing" the variable information into a string. More...
StatusCode	read (const std::string &data)
	Read data from a "serialized" string. More...
bool	operator== (const Variable &var) const
	Operator checking the equivalence of two variables. More...
bool	operator< (const Variable &var) const
	Operator needed to use such objects in STL containers. More...

Static Public Attributes
static const char *const	STRING_SEPARATOR = "$"
	Character separating parts of the variable's metadata. More...

Private Attributes
std::string	m_type
	Full type name of the variable. More...
std::string	m_name
	Name of the variable without its prefix. More...
std::string	m_doc
	Description of the variable. More...
bool	m_primitive
	Flag showing whether the variable is a primitive. More...

Detailed Description

Internal class keeping track of a single variable.

   This class is used internally by the class to keep all the
   important properties of a D3PD variable. It is mainly used
   by the D3PDReader project to store and retrieve information
   about the D3PDObject-s that produced a D3PD.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 131 of file ObjectMetadata.h.

Constructor & Destructor Documentation

Variable()

D3PD::ObjectMetadata::Variable::Variable

(

)

Default constructor.

Definition at line 422 of file ObjectMetadata.cxx.

      : m_type( "" ), m_name( "" ), m_doc( "" ), m_primitive( true ) {
 
   }

Member Function Documentation

doc()

const std::string & D3PD::ObjectMetadata::Variable::doc

(

)

const

Description of the variable.

Definition at line 437 of file ObjectMetadata.cxx.

                                                      {
 
      return m_doc;
   }

name()

const std::string & D3PD::ObjectMetadata::Variable::name

(

)

const

Name of the variable without its prefix.

Definition at line 432 of file ObjectMetadata.cxx.

                                                       {
 
      return m_name;
   }

operator<()

bool D3PD::ObjectMetadata::Variable::operator<

(

const Variable &

var

)

const

Operator needed to use such objects in STL containers.

Definition at line 568 of file ObjectMetadata.cxx.

                                                                                    {
 
      if( name() != var.name() ) {
         return ( name() < var.name() );
      } else {
         return ( type() < var.type() );
      }
   }

operator==()

bool D3PD::ObjectMetadata::Variable::operator==

(

const Variable &

var

)

const

Operator checking the equivalence of two variables.

Definition at line 562 of file ObjectMetadata.cxx.

                                                                                     {
 
      return ( ( name() == var.name() ) &&
               ( type() == var.type() ) );
   }

primitive()

bool D3PD::ObjectMetadata::Variable::primitive

(

)

const

Flag showing whether the variable is a primitive.

Definition at line 442 of file ObjectMetadata.cxx.

                                                {
 
      return m_primitive;
   }

read()

StatusCode D3PD::ObjectMetadata::Variable::read

(

const std::string &

data

)

Read data from a "serialized" string.

This function can be used to read in information from a serialized form.

Note that the function is meant to reset all stored properties of the object. (Unlike the function in D3PD::ObjectMetadata!) This is just because merging doesn't make sense for this class.

Parameters

data	The string that should be decoded

Returns

StatusCode::SUCCESS if the operation was successful, StatusCode::FAILURE otherwise

Definition at line 495 of file ObjectMetadata.cxx.

                                                                  {
 
      //
      // Tokenize the string using Boost:
      //
      boost::char_separator< char > separator( STRING_SEPARATOR, "",
                                               boost::keep_empty_tokens );
      boost::tokenizer< boost::char_separator< char > > tokens( data,
                                                                separator );
      boost::tokenizer< boost::char_separator< char > >::const_iterator itr = tokens.begin();
 
      // Check that we didn't reach the last token yet:
      if( itr == tokens.end() ) {
         REPORT_MESSAGE_WITH_CONTEXT( MSG::FATAL, "ObjectMetadata::Variable" )
            << "The received data can not be parsed successfully: "
            << data;
         return StatusCode::FAILURE;
      }
 
      // Extract the name of the variable:
      m_name = *itr; ++itr;
 
      // Check that we didn't reach the last token yet:
      if( itr == tokens.end() ) {
         REPORT_MESSAGE_WITH_CONTEXT( MSG::FATAL, "ObjectMetadata::Variable" )
            << "The received data can not be parsed successfully: "
            << data;
         return StatusCode::FAILURE;
      }
 
      // Extract the type of the variable:
      m_type = *itr; ++itr;
 
      // Check that we didn't reach the last token yet:
      if( itr == tokens.end() ) {
         REPORT_MESSAGE_WITH_CONTEXT( MSG::FATAL, "ObjectMetadata::Variable" )
            << "The received data can not be parsed successfully: "
            << data;
         return StatusCode::FAILURE;
      }
 
      // Extract the documentation string of the variable:
      m_doc = *itr; ++itr;
 
      // Check that we didn't reach the last token yet:
      if( itr == tokens.end() ) {
         REPORT_MESSAGE_WITH_CONTEXT( MSG::FATAL, "ObjectMetadata::Variable" )
            << "The received data can not be parsed successfully: "
            << data;
         return StatusCode::FAILURE;
      }
 
      // Extract the information of whether this variable is a primitive or not:
      if( *itr == "0" ) {
         m_primitive = false;
      } else if( *itr == "1" ) {
         m_primitive = true;
      } else {
         REPORT_MESSAGE_WITH_CONTEXT( MSG::FATAL, "ObjectMetadata::Variable" )
            << "The received data can not be parsed successfully: "
            << data;
         return StatusCode::FAILURE;
      }
 
      return StatusCode::SUCCESS;
   }

setDoc()

void D3PD::ObjectMetadata::Variable::setDoc

(

const std::string &

doc

)

Set the description of the variable.

Definition at line 459 of file ObjectMetadata.cxx.

                                                             {
 
      m_doc = doc;
      return;
   }

setName()

void D3PD::ObjectMetadata::Variable::setName

(

const std::string &

name

)

Set the name of the variable.

Definition at line 453 of file ObjectMetadata.cxx.

                                                               {
 
      m_name = name;
      return;
   }

setPrimitive()

void D3PD::ObjectMetadata::Variable::setPrimitive

(

bool

primitive

)

Set whether the variable is a primitive.

Definition at line 465 of file ObjectMetadata.cxx.

                                                             {
 
      m_primitive = primitive;
      return;
   }

setType()

void D3PD::ObjectMetadata::Variable::setType

(

const std::string &

type

)

Set the type name of the variable.

Definition at line 447 of file ObjectMetadata.cxx.

                                                               {
 
      m_type = type;
      return;
   }

toString()

std::string D3PD::ObjectMetadata::Variable::toString

(

)

const

Function "serializing" the variable information into a string.

This function translates the contents of the variable into a single string.

The different parts of the configuration string are separated by "$" character. (So variable names and variable descriptions can't have this character in them.)

Returns

The configuration of this variable "serialized" into a string

Definition at line 479 of file ObjectMetadata.cxx.

                                                    {
 
      return m_name + STRING_SEPARATOR + m_type + STRING_SEPARATOR +
         m_doc + STRING_SEPARATOR + ( m_primitive ? "1" : "0" );
   }

type()

const std::string & D3PD::ObjectMetadata::Variable::type

(

)

const

Type name of the variable.

Definition at line 427 of file ObjectMetadata.cxx.

                                                       {
 
      return m_type;
   }

Member Data Documentation

m_doc

std::string D3PD::ObjectMetadata::Variable::m_doc

private

Description of the variable.

Definition at line 164 of file ObjectMetadata.h.

m_name

std::string D3PD::ObjectMetadata::Variable::m_name

private

Name of the variable without its prefix.

Definition at line 163 of file ObjectMetadata.h.

m_primitive

bool D3PD::ObjectMetadata::Variable::m_primitive

private

Flag showing whether the variable is a primitive.

Definition at line 165 of file ObjectMetadata.h.

m_type

std::string D3PD::ObjectMetadata::Variable::m_type

private

Full type name of the variable.

Definition at line 162 of file ObjectMetadata.h.

STRING_SEPARATOR

const char *const D3PD::ObjectMetadata::Variable::STRING_SEPARATOR = "$"

static

Character separating parts of the variable's metadata.

Definition at line 160 of file ObjectMetadata.h.

---

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

• ObjectMetadata.h
• ObjectMetadata.cxx