InfoWidget Class Reference

text-based info viewer showing DataStore contents. More...

#include <InfoWidget.h>

Inheritance diagram for InfoWidget:

Classes
struct	URI
	a parsed URI. More...

Public Member Functions
	InfoWidget (const TGWindow *p)
	ctor.
void	update ()
	reset for new event (try to show same object if it exists).
void	show (const char *uri="main:", bool clearSelection=true)
	Navigate to given URI.
void	show (const TObject *obj)
	Navigate to page belonging to given object.
void	back ()
	navigate to previous page, clearing current page from history.
virtual int	IsVisited (const char *uri) override
	Used to colour visited links.

Private Member Functions
TString	createMainPage () const
	create DataStore overview.
TString	createArrayPage (const URI &uri) const
	create list of array contents.
TString	createObjectPage (const URI &uri) const
	create object info.
TString	getHeader (const URI &uri=URI()) const
	returns string with title, breadcrumbs, menu.
	ClassDefOverride (InfoWidget, 0)
	text-based info viewer showing DataStore contents.

Static Private Member Functions
static TString	getContents (const TObject *obj)
	Get object contents (member data).
static TString	getRelatedInfo (const TObject *obj)
	return HTML-formatted list of related objects.

Private Attributes
std::set< TString >	m_visited
	list of all pages viewed in current event.
std::vector< TString >	m_history
	ordered list of all pages viewed in current event.

Detailed Description

text-based info viewer showing DataStore contents.

Definition at line 27 of file InfoWidget.h.

Constructor & Destructor Documentation

InfoWidget()

InfoWidget ( const TGWindow *  p )

explicit

ctor.

Definition at line 34 of file InfoWidget.cc.

                                       :
  TGHtml(p, 400, 600, -1)
{
  this->Connect("MouseDown(const char*)", "Belle2::InfoWidget", this, "show(const char*)");
 
  //magic to prevent the frame being empty.
  MapSubwindows();
  Resize();
  MapWindow();
}

~InfoWidget()

~InfoWidget

(

)

Definition at line 45 of file InfoWidget.cc.

{
}

Member Function Documentation

back()

void back

(

)

navigate to previous page, clearing current page from history.

Definition at line 79 of file InfoWidget.cc.

{
  m_history.pop_back(); //drop current page
  const TString lastURI = m_history.back();
  m_history.pop_back(); //we'll go there promptly and re-add it
 
  show(lastURI);
}

createArrayPage()

TString createArrayPage ( const URI &  uri ) const

private

create list of array contents.

Definition at line 179 of file InfoWidget.cc.

{
  const StoreArray<TObject> array(uri.entryName.Data(), getDurability(uri.scheme));
  TString info = getHeader(uri);
  if (array.getEntries() != 0) {
    info += HtmlClassInspector::getClassInfo(array[0]->IsA());
  }
 
  for (int i = 0; i < array.getEntries(); i++) {
    TString name = ObjectInfo::getName(array[i]);
    if (name != "")
      name = " - " + name;
    info += TString::Format("<a href='%s:%s/%d'>%s[%d]%s</a><br>",
                            uri.scheme.Data(), uri.entryName.Data(), i,
                            uri.entryName.Data(), i, name.Data());
  }
  return info;
}

createMainPage()

TString createMainPage ( ) const

private

create DataStore overview.

Definition at line 127 of file InfoWidget.cc.

{
  TString info = getHeader();
 
  const char* schemes[] = {"event", "persistent"};
  const DataStore::EDurability durabilities[] = { DataStore::c_Event, DataStore::c_Persistent };
  const char* durabilyNames[] = {"c_Event", "c_Persistent"};
 
  for (int i = 0; i < 2; i++) {
    const TString scheme = schemes[i];
    auto arrayNames = DataStore::Instance().getListOfArrays(TObject::Class(), durabilities[i]);
    if (!arrayNames.empty()) {
      info += "<h2>Arrays";
      if (i > 0) {
        info += " (<tt>";
        info += durabilyNames[i];
        info += "</tt>)";
      }
      info += "</h2>";
    }
    for (std::string name : arrayNames) {
      const StoreArray<TObject> array(name, durabilities[i]);
      int nEntries = array.getEntries();
      if (nEntries)
        info += TString::Format("<a href='%s:%s/'>%s (%d)</a><br>", scheme.Data(), name.c_str(), name.c_str(), nEntries);
      else
        info += TString::Format("%s (%d)<br>", name.c_str(), nEntries);
    }
 
    auto objNames = DataStore::Instance().getListOfObjects(TObject::Class(), durabilities[i]);
    if (!objNames.empty()) {
      info += "<h2>Objects";
      if (i > 0) {
        info += " (<tt>";
        info += durabilyNames[i];
        info += "</tt>)";
      }
      info += "</h2>";
    }
    for (std::string name : objNames) {
      const StoreObjPtr<TObject> obj(name, durabilities[i]);
      if (obj)
        info += TString::Format("<a href='%s:%s/'>%s</a><br>", scheme.Data(), name.c_str(), name.c_str());
      else
        info += TString::Format("%s<br>", name.c_str());
    }
    if (i == 0)
      info += "<hr>";
  }
  return info;
}

createObjectPage()

TString createObjectPage ( const URI &  uri ) const

private

create object info.

Definition at line 198 of file InfoWidget.cc.

{
  TString info = getHeader(uri);
  info += ObjectInfo::getInfo(uri.object);
  info += getRelatedInfo(uri.object);
  info += getContents(uri.object);
 
  return info;
}

getContents()

TString getContents ( const TObject *  obj )

staticprivate

Get object contents (member data).

Definition at line 329 of file InfoWidget.cc.

{
  TString info;
 
  info += "<h4>Object Details</h4>";
  info += HtmlClassInspector::getClassInfo(obj->IsA());
  info += HtmlClassInspector::getMemberData(obj);
 
  return info;
}

getHeader()

TString getHeader ( const URI &  uri = URI() ) const

private

returns string with title, breadcrumbs, menu.

Definition at line 207 of file InfoWidget.cc.

{
  int numEntries = -1;
  if (uri.entryName.Length() != 0 and (!uri.object or uri.arrayIndex != -1)) {
    const StoreArray<TObject> array(uri.entryName.Data(), getDurability(uri.scheme));
    numEntries = array.getEntries();
  }
 
  TString col;
  if (uri.object and VisualRepMap::getInstance()->isVisualized(uri.object))
    col = "#d2ede4"; //needs to be lighter than purple/blue used for links
  else
    col = TangoPalette::getHex("Aluminium", 1);
  TString info;
  info += "<table border=0 width=100% bgcolor=" + col + "><tr>";
  //breadcrumbs
  info += "<td>";
  info += "<a href='main:'>DataStore</a> / ";
  if (uri.arrayIndex != -1) {
    info += "<a href='" + uri.scheme + ":" + uri.entryName + "/'>" + uri.entryName + "</a>";
    info += TString::Format("<b>[%d]</b>", uri.arrayIndex);
  } else {
    info += "<b>" + uri.entryName + "</b>";
  }
  info += "</td>";
 
  //back button
  if (m_history.size() <= 1) //current page is part of history, so we need at least two
    info += "<td align=right>Back</td>";
  else
    info += "<td align=right><a href='back:'>Back</a></td>";
 
 
  info += "</tr></table>";
 
  //short header for DataStore overview
  if (uri.entryName == "")
    return info;
 
  //title
  if (uri.object) {
    TString name = ObjectInfo::getName(uri.object);
    if (name != "")
      name = " - " + name;
    info += "<h2>" + ObjectInfo::getIdentifier(uri.object) + name + "</h2>";
  } else {
    info += TString::Format("<h2>%s (%d)</h2>", uri.entryName.Data(), numEntries);
  }
 
 
  if (uri.arrayIndex != -1) { //this is an array
    if (uri.arrayIndex == 0)
      info += "Previous";
    else
      info += "<a href='" + uri.scheme + ":" + TString::Format("%s/%d", uri.entryName.Data(), uri.arrayIndex - 1) + "'>Previous</a>";
    info += " ";
    if (uri.arrayIndex == numEntries - 1)
      info += "Next";
    else
      info += "<a href='" + uri.scheme + ":" + TString::Format("%s/%d", uri.entryName.Data(), uri.arrayIndex + 1) + "'>Next</a>";
    info += "<br> <br>";
  }
 
  return info;
}

getRelatedInfo()

TString getRelatedInfo ( const TObject *  obj )

staticprivate

return HTML-formatted list of related objects.

Definition at line 282 of file InfoWidget.cc.

{
  TString info;
  info += "<h4>Related Objects</h4>";
 
  StoreEntry* storeEntry = nullptr;
  int index = -1;
  {
    //relations from this
    const RelationVector<TObject> relatedObjects(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, obj, storeEntry, index,
                                                 TObject::Class(), "ALL", ""));
    const TString pref = "this <b>-&gt;</b> ";
    for (size_t i = 0; i < relatedObjects.size(); i++) {
      const TObject* relObj = relatedObjects.object(i);
      double weight = relatedObjects.weight(i);
      TString name = ObjectInfo::getName(relObj);
      if (name != "")
        name = " - " + name;
      info += pref + "<a href='" + URI::getURI(relObj) + "'>" + ObjectInfo::getIdentifier(relObj) + name + "</a>";
      if (weight != 1.0)
        info += TString::Format(" (weight: %.3g)", weight);
      info += "<br>";
    }
  }
 
  info += " <br>"; //extra space needed!
  {
    //relations to this
    const RelationVector<TObject> relatedObjects(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, obj, storeEntry, index,
                                                 TObject::Class(), "ALL", ""));
 
    const TString pref = "this <b>&lt;-</b> ";
    for (size_t i = 0; i < relatedObjects.size(); i++) {
      const TObject* relObj = relatedObjects.object(i);
      double weight = relatedObjects.weight(i);
      TString name = ObjectInfo::getName(relObj);
      if (name != "")
        name = " - " + name;
      info += pref + "<a href='" + URI::getURI(relObj) + "'>" + ObjectInfo::getIdentifier(relObj) + name + "</a>";
      if (weight != 1.0)
        info += TString::Format(" (weight: %.3g)", weight);
      info += "<br>";
    }
  }
  return info;
}

IsVisited()

int IsVisited ( const char *  uri )

overridevirtual

Used to colour visited links.

Definition at line 49 of file InfoWidget.cc.

{
  //not actually sure why return type is 'int'...
  return (bool)m_visited.count(uri);
}

show() [1/2]

void show	(	const char *	uri = "main:",
		bool	clearSelection = true
	)

Navigate to given URI.

Parameters

uri	what to show, see InfoWidget::URI
clearSelection	when showing an object, this determines wether to clear an existing selection

Definition at line 93 of file InfoWidget.cc.

{
  B2DEBUG(100, "Navigating to: " << uri);
 
  if (std::string(uri) == "back:") {
    back();
    return;
  }
 
  m_visited.insert(uri);
  m_history.push_back(uri);
 
  URI parsedURI = URI(uri);
  TString info;
  if (parsedURI.object) {
    info = createObjectPage(parsedURI);
 
    //highlight in display
    if (clearSelection)
      VisualRepMap::getInstance()->clearSelection();
    VisualRepMap::getInstance()->select(parsedURI.object);
  } else if (parsedURI.entryName != "") {
    info = createArrayPage(parsedURI);
  } else {
    info = createMainPage();
  }
  info = "<html><body>" + info + "</body></html>";
 
  Clear();
  //string only passed to function taking const char*...
  ParseText(const_cast<char*>(info.Data()));
  Layout();
}

show() [2/2]

void show

(

const TObject *

obj

)

Navigate to page belonging to given object.

Special in that it doesn't clear the current selection.

Definition at line 88 of file InfoWidget.cc.

{
  show(URI::getURI(obj).Data(), false);
}

update()

void update

(

)

reset for new event (try to show same object if it exists).

Definition at line 55 of file InfoWidget.cc.

{
  TString lastURI = "";
  if (!m_history.empty()) {
    lastURI = m_history.back();
  }
  m_visited.clear();
  m_history.clear();
 
  //check if the object given by lastURI exists in the new event, too.
  //array pages are ok, too
  if (lastURI != "") {
    URI parsedURI(lastURI);
    if (!parsedURI.object and !lastURI.EndsWith("/")) {
      //doesn't exist, go to main page
      lastURI = "";
    }
  }
 
  if (lastURI == "")
    lastURI = "main:";
  show(lastURI);
}

Member Data Documentation

m_history

std::vector<TString> m_history

private

ordered list of all pages viewed in current event.

Definition at line 95 of file InfoWidget.h.

m_visited

std::set<TString> m_visited

private

list of all pages viewed in current event.

Definition at line 93 of file InfoWidget.h.

---

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

• display/include/InfoWidget.h
• display/src/InfoWidget.cc