PStatCollector

Inheritance:

Methods of PStatCollector:

addLevel
void PStatCollector::add_level(float increment);

Description: Adds the indicated increment (which may be negative) to the level setting associated with this collector for the main thread. If the collector did not already have a level setting for the main thread, it is initialized to 0.
Description: Adds the indicated increment (which may be negative) to the level setting associated with this collector for the indicated thread. If the collector did not already have a level setting for this thread, it is initialized to 0.

clearLevel
void PStatCollector::clear_level(void);

Description: Removes the level setting associated with this collector for the main thread. The collector will no longer show up on any level graphs in the main thread.
Description: Removes the level setting associated with this collector for the indicated thread. The collector will no longer show up on any level graphs in this thread.

getIndex
int PStatCollector::get_index(void) const;

Description: Returns the index number of this particular collector within the PStatClient.

getLevel
float PStatCollector::get_level(void);

Description: Returns the current level value of the given collector.

isActive
bool PStatCollector::is_active(void);

Description: Returns true if this particular collector is active on the default thread, and we are currently transmitting PStats data.
Description: Returns true if this particular collector is active on the indicated thread, and we are currently transmitting PStats data.

isStarted
bool PStatCollector::is_started(void);

Description: Returns true if this particular collector has been started on the default thread, or false otherwise.
Description: Returns true if this particular collector has been started on the indicated thread, or false otherwise.

operator =
void PStatCollector::operator =(PStatCollector const &copy);

Description:

setLevel
void PStatCollector::set_level(float level);

Description: Sets the level setting associated with this collector for the main thread to the indicated value.
Description: Sets the level setting associated with this collector for the indicated thread to the indicated value.

start
void PStatCollector::start(void);

Description: Starts this particular timer ticking. This should be called before the code you want to measure.
Description: Starts this timer ticking within a particular thread.
Description: Marks that the timer should have been started as of the indicated time. This must be a time based on the PStatClient's clock (see PStatClient::get_clock()), and care should be taken that all such calls exhibit a monotonically increasing series of time values.

stop
void PStatCollector::stop(void);

Description: Stops this timer. This should be called after the code you want to measure.
Description: Stops this timer within a particular thread.
Description: Marks that the timer should have been stopped as of the indicated time. This must be a time based on the PStatClient's clock (see PStatClient::get_clock()), and care should be taken that all such calls exhibit a monotonically increasing series of time values.

subLevel
void PStatCollector::sub_level(float decrement);

Description: Subtracts the indicated decrement (which may be negative) to the level setting associated with this collector for the main thread. If the collector did not already have a level setting for the main thread, it is initialized to 0.
Description: Subtracts the indicated decrement (which may be negative) to the level setting associated with this collector for the indicated thread. If the collector did not already have a level setting for this thread, it is initialized to 0.