Belle II Software  release-06-01-15
Belle2::HTML Namespace Reference

return information on objects in a nice format. More...

Functions

std::string getString (const TMatrixFBase &matrix, int precision=2, bool color=true)
 get HTML table representing a matrix. More...
 
std::string getString (const TMatrixDBase &matrix, int precision=2, bool color=true)
 get HTML table representing a matrix (double precision). More...
 
std::string getString (const TVector3 &vec, int precision=2)
 get a string with vector coordinates: (x, y, z). More...
 
std::string getStringConvertToUnit (const TVector3 &vec, int precision=2, const std::string &unitType="cm")
 get a string with vector coordinates: (x, y, z). More...
 
std::string chooseUnitOfLength (const TVector3 &vec)
 get a string with a unit type to convert a vector, so that it is easily readable. More...
 
std::string getHexDump (const int *buf, int length)
 Create hexdump of given buffer. More...
 
std::string htmlToPlainText (const std::string &html)
 Reformat given HTML string into terminal-friendly plain text.
 
std::string escape (const std::string &str)
 Convert &, <, > etc. More...
 
std::string unescape (const std::string &str)
 inverse of escape()
 

Detailed Description

return information on objects in a nice format.

See also
RelationsObject::getInfoHTML()

Function Documentation

◆ chooseUnitOfLength()

std::string chooseUnitOfLength ( const TVector3 &  vec)

get a string with a unit type to convert a vector, so that it is easily readable.

valid unit types are (um, cm) for now. the maximum of the vector entries defines the unit.

Definition at line 103 of file HTML.cc.

104 {
105  double xyz [3];
106  std::string unitType;
107  vec.GetXYZ(xyz);
108  double max = 0;
109 
110  for (auto entry : xyz)
111  if (std::abs(entry) > max)
112  max = std::abs(entry);
113 
114  // choose specific range for that the unit is useful
115  if (max < 0.1)
116  unitType = "um";
117  else
118  unitType = "cm";
119  return unitType;
120 }

◆ escape()

std::string escape ( const std::string &  str)

Convert &, <, > etc.

to entities. (not a complete list!)

Definition at line 160 of file HTML.cc.

◆ getHexDump()

std::string getHexDump ( const int *  buf,
int  length 
)

Create hexdump of given buffer.

Parameters
bufthe buffer
lengthsize of buf in 32bit words

Definition at line 122 of file HTML.cc.

◆ getString() [1/3]

std::string getString ( const TMatrixDBase &  matrix,
int  precision = 2,
bool  color = true 
)

get HTML table representing a matrix (double precision).

Parameters
matrixThe matrix to be represented
precisionThe amount of significant digits to use
colorIf true, vary background colour depending on value.

Definition at line 37 of file HTML.cc.

◆ getString() [2/3]

std::string getString ( const TMatrixFBase &  matrix,
int  precision = 2,
bool  color = true 
)

get HTML table representing a matrix.

Parameters
matrixThe matrix to be represented
precisionThe amount of significant digits to use
colorIf true, vary background colour depending on value.

Definition at line 25 of file HTML.cc.

◆ getString() [3/3]

std::string getString ( const TVector3 &  vec,
int  precision = 2 
)

get a string with vector coordinates: (x, y, z).

(uses fixed-length output).

Parameters
vecthe vector to be printend
precisionThe amount of digits to use

Definition at line 77 of file HTML.cc.

◆ getStringConvertToUnit()

std::string getStringConvertToUnit ( const TVector3 &  vec,
int  precision = 2,
const std::string &  unitType = "cm" 
)

get a string with vector coordinates: (x, y, z).

(uses fixed-length output). converts floating point value from standard framework unit to given unit.

Parameters
vecthe vector to be printend
precisionThe amount of digits to use
unitTypeDefines the unit to convert the vector values from standard framework unit.

Definition at line 86 of file HTML.cc.