SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Attributes
InfoBox Class Reference

Stores the MICE run information to be printed as TPaveText. More...

#include <InfoBox.hh>

Public Member Functions

 InfoBox (const std::string type="", const std::string maus="", const std::string run="", const std::string cycle="")
 MAUS info box constructor, sets the necessary information. More...
 
 InfoBox (const InfoBox &ib)
 Copy constructor. More...
 
InfoBox & operator= (const InfoBox &ib)
 Equality operator. More...
 
 ~InfoBox ()
 Destructor. More...
 
void SetPosition (const std::string &pos, const double alpha=.02, const double beta=.16)
 Updates the position of the info box. More...
 
void SetPosition (const double &xmin, const double &ymin, const double &xmax, const double &ymax)
 Updates the position of the info box. More...
 
void SetOpacity (const double &opacity)
 Sets the opacity of the TPaveText (0 is transparent, 1 is fully opaque) More...
 
void Draw ()
 Draws the info box on the current canvas. More...
 

Private Attributes

TPaveText * _text
 Info box. More...
 
std::string _type
 Type of data represented. More...
 
std::string _maus
 Version of MAUS. More...
 
std::string _run
 Run tag. More...
 
std::string _cycle
 ISIS user cycle. More...
 

Detailed Description

Stores the MICE run information to be printed as TPaveText.

Defines the style of the MICE information text box. Sets the default position of the information box, which may be overwritten if necessary.

Constructor & Destructor Documentation

InfoBox::InfoBox ( const std::string  type = "",
const std::string  maus = "",
const std::string  run = "",
const std::string  cycle = "" 
)

MAUS info box constructor, sets the necessary information.

Parameters
typeType of data presented: [simulated], Preliminary, etc.
mausVersion of MAUS used
runRun simulated or reconstructed
cycleISIS user cycle tag
InfoBox::InfoBox ( const InfoBox &  ib)

Copy constructor.

InfoBox::~InfoBox ( )

Destructor.

Member Function Documentation

void InfoBox::Draw ( )

Draws the info box on the current canvas.

InfoBox & InfoBox::operator= ( const InfoBox &  ib)

Equality operator.

void InfoBox::SetOpacity ( const double &  opacity)

Sets the opacity of the TPaveText (0 is transparent, 1 is fully opaque)

Parameters
opacityValue of the opacity (from 0 to 1)
void InfoBox::SetPosition ( const std::string &  pos,
const double  alpha = .02,
const double  beta = .16 
)

Updates the position of the info box.

Parameters
posCorner in which to draw the info box (tl, tr, bl, br)
alphaRelative margin from the edges of the TCanvas [%]
betaRelative size [%]
void InfoBox::SetPosition ( const double &  xmin,
const double &  ymin,
const double &  xmax,
const double &  ymax 
)

Updates the position of the info box.

Parameters
xminMinimum x position in NDC
yminMinimum y position in NDC
xmaxMaximum x position in NDC
ymaxMaximum y position in NDC

Field Documentation

std::string InfoBox::_cycle
private

ISIS user cycle.

std::string InfoBox::_maus
private

Version of MAUS.

std::string InfoBox::_run
private

Run tag.

TPaveText* InfoBox::_text
private

Info box.

std::string InfoBox::_type
private

Type of data represented.


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