Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes

PStatGraph Class Reference

This is an abstract base class for several different kinds of graphs that have a few things in common, like labels and guide bars. More...

#include "pStatGraph.h"

Inheritance diagram for PStatGraph:
PStatPianoRoll PStatStripChart GtkStatsPianoRoll WinStatsPianoRoll GtkStatsStripChart WinStatsStripChart

List of all members.

Classes

class  GuideBar

Public Types

enum  GuideBarStyle { GBS_normal, GBS_target, GBS_user }
enum  GuideBarUnits { GBU_hz = 0x0001, GBU_ms = 0x0002, GBU_named = 0x0004, GBU_show_units = 0x0008 }

Public Member Functions

 PStatGraph (PStatMonitor *monitor, int xsize, int ysize)
int add_user_guide_bar (float height)
 Creates a new user guide bar and returns its index number.
int find_user_guide_bar (float from_height, float to_height) const
 Returns the index number of the first user guide bar found whose height is within the indicated range, or -1 if no user guide bars fall within the range.
const GuideBar & get_guide_bar (int n) const
 Returns the nth horizontal guide bar.
const string & get_guide_bar_unit_name () const
 Returns the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.
int get_guide_bar_units () const
 Returns the units that are displayed for the guide bar labels.
int get_label_collector (int n) const
 Returns the collector index associated with the nth label.
RGBColorf get_label_color (int n) const
 Returns the color associated with the nth label.
string get_label_name (int n) const
 Returns the text associated with the nth label.
PStatMonitor * get_monitor () const
 Returns the monitor associated with this chart.
int get_num_guide_bars () const
 Returns the number of horizontal guide bars that should be drawn, based on the indicated target frame rate.
int get_num_labels () const
 Returns the number of labels to be drawn for this chart.
int get_num_user_guide_bars () const
 Returns the current number of user-defined guide bars.
float get_target_frame_rate () const
 Returns the indicated target frame rate in Hz.
GuideBar get_user_guide_bar (int n) const
 Returns the nth user-defined guide bar.
int get_xsize () const
 Returns the width of the chart in pixels.
int get_ysize () const
 Returns the height of the chart in pixels.
void move_user_guide_bar (int n, float height)
 Adjusts the height of the nth user-defined guide bar.
void remove_user_guide_bar (int n)
 Removes the user guide bar with the indicated index number.
void set_guide_bar_unit_name (const string &unit_name)
 Sets the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.
void set_guide_bar_units (int unit_mask)
 Sets the units that are displayed for the guide bar labels.
void set_target_frame_rate (float frame_rate)
 Sets the target frame rate of the application in Hz.

Static Public Member Functions

static string format_number (float value)
 Returns a string representing the value nicely formatted for its range.
static string format_number (float value, int guide_bar_units, const string &unit_name=string())
 Returns a string representing the value nicely formatted for its range, including the units as indicated.

Protected Types

typedef pvector< GuideBar > GuideBars
typedef vector_int Labels

Protected Member Functions

GuideBar make_guide_bar (float value, GuideBarStyle style=GBS_normal) const
 Makes a guide bar for the indicated elapsed time or level units.
virtual void normal_guide_bars ()=0
 PT (PStatMonitor) _monitor
void update_guide_bars (int num_bars, float scale)
 Resets the list of guide bars.

Protected Attributes

int _guide_bar_units
GuideBars _guide_bars
bool _guide_bars_changed
Labels _labels
bool _labels_changed
float _target_frame_rate
string _unit_name
int _xsize
int _ysize

Detailed Description

This is an abstract base class for several different kinds of graphs that have a few things in common, like labels and guide bars.

Definition at line 36 of file pStatGraph.h.

Member Function Documentation

int PStatGraph::add_user_guide_bar ( float  height)

Creates a new user guide bar and returns its index number.

Definition at line 148 of file pStatGraph.cxx.

Referenced by GtkStatsStripChart::handle_motion().

int PStatGraph::find_user_guide_bar ( float  from_height,
float  to_height 
) const

Returns the index number of the first user guide bar found whose height is within the indicated range, or -1 if no user guide bars fall within the range.

Definition at line 172 of file pStatGraph.cxx.

Referenced by WinStatsStripChart::consider_drag_start(), and GtkStatsStripChart::consider_drag_start().

string PStatGraph::format_number ( float  value) [static]

Returns a string representing the value nicely formatted for its range.

Definition at line 184 of file pStatGraph.cxx.

Referenced by format_number(), make_guide_bar(), WinStatsStripChart::new_data(), and GtkStatsStripChart::new_data().

string PStatGraph::format_number ( float  value,
int  guide_bar_units,
const string &  unit_name = string() 
) [static]

Returns a string representing the value nicely formatted for its range, including the units as indicated.

Definition at line 210 of file pStatGraph.cxx.

References format_number().

const PStatGraph::GuideBar & PStatGraph::get_guide_bar ( int  n) const

Returns the nth horizontal guide bar.

This should be drawn as a horizontal line across the chart at the y pixel location determined by height_to_pixel(bar._height).

It is possible that this bar will be off the top of the chart.

Definition at line 101 of file pStatGraph.cxx.

Referenced by WinStatsStripChart::additional_window_paint(), WinStatsStripChart::end_draw(), and GtkStatsStripChart::end_draw().

const string & PStatGraph::get_guide_bar_unit_name ( ) const [inline]

Returns the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.

Definition at line 164 of file pStatGraph.I.

Referenced by WinStatsStripChart::new_data(), and GtkStatsStripChart::new_data().

int PStatGraph::get_guide_bar_units ( ) const [inline]

Returns the units that are displayed for the guide bar labels.

This may be a union of one or more members of the GuideBarUnits enum.

Definition at line 140 of file pStatGraph.I.

Referenced by WinStatsStripChart::new_data(), GtkStatsStripChart::new_data(), WinStatsStripChart::set_time_units(), and GtkStatsStripChart::set_time_units().

int PStatGraph::get_label_collector ( int  n) const [inline]

Returns the collector index associated with the nth label.

Definition at line 44 of file pStatGraph.I.

Referenced by WinStatsStripChart::update_labels(), and GtkStatsStripChart::update_labels().

RGBColorf PStatGraph::get_label_color ( int  n) const [inline]

Returns the color associated with the nth label.

Definition at line 66 of file pStatGraph.I.

string PStatGraph::get_label_name ( int  n) const [inline]

Returns the text associated with the nth label.

Definition at line 55 of file pStatGraph.I.

PStatMonitor * PStatGraph::get_monitor ( ) const [inline]

Returns the monitor associated with this chart.

Definition at line 22 of file pStatGraph.I.

Referenced by PStatStripChart::update(), and PStatStripChart::update_labels().

int PStatGraph::get_num_guide_bars ( ) const

Returns the number of horizontal guide bars that should be drawn, based on the indicated target frame rate.

Not all of these may be visible; some may be off the top of the chart because of the vertical scale.

Definition at line 86 of file pStatGraph.cxx.

Referenced by WinStatsStripChart::additional_window_paint(), WinStatsStripChart::end_draw(), and GtkStatsStripChart::end_draw().

int PStatGraph::get_num_labels ( ) const [inline]

Returns the number of labels to be drawn for this chart.

Definition at line 33 of file pStatGraph.I.

Referenced by WinStatsStripChart::update_labels(), and GtkStatsStripChart::update_labels().

int PStatGraph::get_num_user_guide_bars ( ) const

Returns the current number of user-defined guide bars.

Not all of these may be visible.

Definition at line 116 of file pStatGraph.cxx.

Referenced by WinStatsStripChart::additional_graph_window_paint(), GtkStatsStripChart::additional_graph_window_paint(), and WinStatsStripChart::additional_window_paint().

float PStatGraph::get_target_frame_rate ( ) const [inline]

Returns the indicated target frame rate in Hz.

See set_target_frame_rate().

Definition at line 93 of file pStatGraph.I.

Referenced by PStatStripChart::set_default_vertical_scale().

PStatGraph::GuideBar PStatGraph::get_user_guide_bar ( int  n) const

Returns the nth user-defined guide bar.

Definition at line 126 of file pStatGraph.cxx.

References make_guide_bar().

Referenced by WinStatsStripChart::additional_graph_window_paint(), GtkStatsStripChart::additional_graph_window_paint(), and WinStatsStripChart::additional_window_paint().

int PStatGraph::get_xsize ( ) const [inline]

Returns the width of the chart in pixels.

Definition at line 103 of file pStatGraph.I.

Referenced by WinStatsStripChart::additional_graph_window_paint(), GtkStatsStripChart::additional_graph_window_paint(), WinStatsStripChart::clear_region(), GtkStatsStripChart::clear_region(), WinStatsStripChart::consider_drag_start(), GtkStatsStripChart::consider_drag_start(), PStatPianoRoll::normal_guide_bars(), PStatStripChart::pixel_to_timestamp(), and PStatStripChart::timestamp_to_pixel().

int PStatGraph::get_ysize ( ) const [inline]

Returns the height of the chart in pixels.

Definition at line 113 of file pStatGraph.I.

Referenced by WinStatsStripChart::clear_region(), GtkStatsStripChart::clear_region(), WinStatsStripChart::consider_drag_start(), GtkStatsStripChart::consider_drag_start(), WinStatsStripChart::copy_region(), GtkStatsStripChart::copy_region(), WinStatsStripChart::draw_cursor(), GtkStatsStripChart::draw_cursor(), WinStatsStripChart::draw_empty(), GtkStatsStripChart::draw_empty(), WinStatsStripChart::draw_slice(), GtkStatsStripChart::draw_slice(), WinStatsStripChart::end_draw(), GtkStatsStripChart::end_draw(), PStatStripChart::get_collector_under_pixel(), GtkStatsStripChart::handle_button_release(), GtkStatsStripChart::handle_motion(), PStatStripChart::height_to_pixel(), and PStatStripChart::pixel_to_height().

PStatGraph::GuideBar PStatGraph::make_guide_bar ( float  value,
PStatGraph::GuideBarStyle  style = GBS_normal 
) const [protected]

Makes a guide bar for the indicated elapsed time or level units.

Definition at line 295 of file pStatGraph.cxx.

References format_number().

Referenced by WinStatsStripChart::additional_window_paint(), get_user_guide_bar(), and update_guide_bars().

void PStatGraph::move_user_guide_bar ( int  n,
float  height 
)

Adjusts the height of the nth user-defined guide bar.

Definition at line 137 of file pStatGraph.cxx.

Referenced by GtkStatsStripChart::handle_button_release(), and GtkStatsStripChart::handle_motion().

void PStatGraph::remove_user_guide_bar ( int  n)

Removes the user guide bar with the indicated index number.

All subsequent index numbers are adjusted down one.

Definition at line 160 of file pStatGraph.cxx.

Referenced by GtkStatsStripChart::handle_button_release().

void PStatGraph::set_guide_bar_unit_name ( const string &  unit_name) [inline]

Sets the name of the units to be used for the guide bars if the units type is set to GBU_named | GBU_show_units.

Definition at line 152 of file pStatGraph.I.

void PStatGraph::set_guide_bar_units ( int  guide_bar_units) [inline]

Sets the units that are displayed for the guide bar labels.

This may be a union of one or more members of the GuideBarUnits enum.

Definition at line 125 of file pStatGraph.I.

Referenced by WinStatsStripChart::set_time_units(), and GtkStatsStripChart::set_time_units().

void PStatGraph::set_target_frame_rate ( float  frame_rate) [inline]

Sets the target frame rate of the application in Hz.

This only affects the choice of initial scale and the placement of guide bars.

Definition at line 79 of file pStatGraph.I.

void PStatGraph::update_guide_bars ( int  num_bars,
float  scale 
) [protected]

Resets the list of guide bars.

Definition at line 257 of file pStatGraph.cxx.

References make_guide_bar().

Referenced by PStatStripChart::normal_guide_bars(), and PStatPianoRoll::normal_guide_bars().

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