JiveXML::IFormatTool Class Reference

Abstract interface to event data formatting classes. More...

#include <IFormatTool.h>

Inheritance diagram for JiveXML::IFormatTool:

Collaboration diagram for JiveXML::IFormatTool:

Public Member Functions
virtual StatusCode	initialize ()=0
	Pure virtual interface functions. More...
virtual StatusCode	finalize ()=0
virtual StatusCode	SetTag (const TagType tag)=0
	Set additional tags. More...
virtual StatusCode	StartEvent (const unsigned long EventNumber, const unsigned int RunNumber, const std::string &DateTime, const unsigned int lumiBlock, const std::string &eventProperty, const std::string &geometryVersion)=0
	Start a new event. More...
virtual StatusCode	EndEvent ()=0
	Finialize this event. More...
virtual StatusCode	AddToEvent (const std::string &component, const std::string &key, const DataMap *aMap)=0
	Append a formatted version of one event component. More...
virtual const std::ostringstream *	getFormattedEvent () const =0
	Return the formated string. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	The interface identifier. More...

Detailed Description

Abstract interface to event data formatting classes.

Currently, one JiveXML format is implemented, but other text formats can easily be imagined.

Author

Sebastian Boeser

Definition at line 23 of file IFormatTool.h.

Member Function Documentation

AddToEvent()

virtual StatusCode JiveXML::IFormatTool::AddToEvent ( const std::string &  component, const std::string &  key, const DataMap *  aMap  )

pure virtual

Append a formatted version of one event component.

Implemented in JiveXML::XMLFormatTool.

EndEvent()

virtual StatusCode JiveXML::IFormatTool::EndEvent ( )

pure virtual

Finialize this event.

Implemented in JiveXML::XMLFormatTool.

finalize()

virtual StatusCode JiveXML::IFormatTool::finalize ( )

pure virtual

Implemented in JiveXML::XMLFormatTool.

getFormattedEvent()

virtual const std::ostringstream* JiveXML::IFormatTool::getFormattedEvent ( ) const

pure virtual

Return the formated string.

Implemented in JiveXML::XMLFormatTool.

initialize()

virtual StatusCode JiveXML::IFormatTool::initialize ( )

pure virtual

Pure virtual interface functions.

Implemented in JiveXML::XMLFormatTool.

interfaceID()

const InterfaceID & JiveXML::IFormatTool::interfaceID ( )

inlinestatic

The interface identifier.

Definition at line 56 of file IFormatTool.h.

  { 
          return IID_IFormatTool; 
  }

SetTag()

virtual StatusCode JiveXML::IFormatTool::SetTag ( const TagType  tag )

pure virtual

Set additional tags.

Implemented in JiveXML::XMLFormatTool.

StartEvent()

virtual StatusCode JiveXML::IFormatTool::StartEvent ( const unsigned long  EventNumber, const unsigned int  RunNumber, const std::string &  DateTime, const unsigned int  lumiBlock, const std::string &  eventProperty, const std::string &  geometryVersion  )

pure virtual

Start a new event.

Implemented in JiveXML::XMLFormatTool.

---

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

• IFormatTool.h