Panda3D
Public Member Functions | Static Public Member Functions | Protected Member Functions

PStatThreadData Class Reference

A collection of FrameData structures for recently-received frames within a particular thread. More...

#include "pStatThreadData.h"

Inheritance diagram for PStatThreadData:
ReferenceCount MemoryBase

List of all members.

Public Member Functions

 PStatThreadData (const PStatClientData *client_data)
const PStatClientDataget_client_data () const
 Returns a pointer to the ClientData structure associated with this data.
bool get_elapsed_frames (int &then_i, int &now_i) const
 Computes the oldest frame number not older than pstats_average_time seconds, and the newest frame number.
const PStatFrameDataget_frame (int frame_number) const
 Returns a FrameData structure associated with the indicated frame number.
const PStatFrameDataget_frame_at_time (float time) const
 Returns the FrameData structure associated with the latest frame not later than the indicated time.
int get_frame_number_at_time (float time, int hint=-1) const
 Returns the frame number of the latest frame not later than the indicated time.
float get_frame_rate () const
 Computes the average frame rate over the past pstats_average_time seconds, by counting up the number of frames elapsed in that time interval.
float get_history () const
 Returns the number of seconds worth of frames that will be retained by the ThreadData structure as each new frame is added.
const PStatFrameDataget_latest_frame () const
 Returns the FrameData associated with the most recent frame.
int get_latest_frame_number () const
 Returns the frame number of the most recent frame stored in the data.
float get_latest_time () const
 Returns the timestamp (in seconds elapsed since connection) of the latest available frame.
int get_oldest_frame_number () const
 Returns the frame number of the oldest frame still stored in the data.
float get_oldest_time () const
 Returns the timestamp (in seconds elapsed since connection) of the oldest available frame.
int get_ref_count () const
 Returns the current reference count.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_frame (int frame_number) const
 Returns true if we have received data for the indicated frame number from the client and we still have it stored, or false otherwise.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
bool is_empty () const
 Returns true if the structure contains no frames, false otherwise.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void record_new_frame (int frame_number, PStatFrameData *frame_data)
 Makes room for and stores a new frame's worth of data.
void ref () const
 Explicitly increments the reference count.
void set_history (float time)
 Sets the number of seconds worth of frames that will be retained by the ThreadData structure as each new frame is added.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Protected Member Functions

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.

Detailed Description

A collection of FrameData structures for recently-received frames within a particular thread.

This holds the raw data as reported by the client, and it automatically handles frames received out-of-order or skipped. You can ask for a particular frame by frame number or time and receive the data for the nearest frame.

Definition at line 38 of file pStatThreadData.h.


Member Function Documentation

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

const PStatClientData * PStatThreadData::get_client_data ( ) const [inline]

Returns a pointer to the ClientData structure associated with this data.

Definition at line 23 of file pStatThreadData.I.

bool PStatThreadData::get_elapsed_frames ( int &  then_i,
int &  now_i 
) const

Computes the oldest frame number not older than pstats_average_time seconds, and the newest frame number.

Handy for computing average frame rate over a time. Returns true if there is any data in that range, false otherwise.

Definition at line 239 of file pStatThreadData.cxx.

Referenced by PStatStripChart::get_average_net_value(), and get_frame_rate().

const PStatFrameData & PStatThreadData::get_frame ( int  frame_number) const

Returns a FrameData structure associated with the indicated frame number.

If the frame data has not yet been received from the client, returns the newest frame older than the requested frame.

Definition at line 107 of file pStatThreadData.cxx.

References PStatFrameData::get_start().

Referenced by PStatStripChart::compute_average_pixel_data(), PStatStripChart::get_average_net_value(), get_frame_at_time(), PStatStripChart::get_frame_data(), TextMonitor::new_data(), PStatStripChart::update(), and PStatPianoRoll::update().

const PStatFrameData & PStatThreadData::get_frame_at_time ( float  time) const

Returns the FrameData structure associated with the latest frame not later than the indicated time.

Definition at line 168 of file pStatThreadData.cxx.

References get_frame(), and get_frame_number_at_time().

int PStatThreadData::get_frame_number_at_time ( float  time,
int  hint = -1 
) const

Returns the frame number of the latest frame not later than the indicated time.

If the hint is nonnegative, it represents a frame number that we believe the correct answer to be near, which may speed the search for the frame.

Definition at line 183 of file pStatThreadData.cxx.

References PStatFrameData::get_start().

Referenced by PStatStripChart::get_collector_under_pixel(), get_frame_at_time(), and PStatStripChart::set_auto_vertical_scale().

float PStatThreadData::get_frame_rate ( ) const

Computes the average frame rate over the past pstats_average_time seconds, by counting up the number of frames elapsed in that time interval.

Definition at line 257 of file pStatThreadData.cxx.

References get_elapsed_frames().

Referenced by WinStatsMonitor::idle(), GtkStatsMonitor::idle(), and TextMonitor::new_data().

float PStatThreadData::get_history ( ) const

Returns the number of seconds worth of frames that will be retained by the ThreadData structure as each new frame is added.

This affects how old the oldest frame that may be queried is.

Definition at line 292 of file pStatThreadData.cxx.

const PStatFrameData & PStatThreadData::get_latest_frame ( ) const

Returns the FrameData associated with the most recent frame.

Definition at line 224 of file pStatThreadData.cxx.

int PStatThreadData::get_latest_frame_number ( ) const

Returns the frame number of the most recent frame stored in the data.

Definition at line 66 of file pStatThreadData.cxx.

Referenced by PStatStripChart::compute_average_pixel_data(), TextMonitor::new_data(), PStatStripChart::update(), and PStatPianoRoll::update().

float PStatThreadData::get_latest_time ( ) const

Returns the timestamp (in seconds elapsed since connection) of the latest available frame.

Definition at line 144 of file pStatThreadData.cxx.

int PStatThreadData::get_oldest_frame_number ( ) const

Returns the frame number of the oldest frame still stored in the data.

Definition at line 78 of file pStatThreadData.cxx.

float PStatThreadData::get_oldest_time ( ) const

Returns the timestamp (in seconds elapsed since connection) of the oldest available frame.

Definition at line 156 of file pStatThreadData.cxx.

Referenced by PStatStripChart::compute_average_pixel_data().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool PStatThreadData::has_frame ( int  frame_number) const

Returns true if we have received data for the indicated frame number from the client and we still have it stored, or false otherwise.

Definition at line 91 of file pStatThreadData.cxx.

Referenced by PStatStripChart::set_auto_vertical_scale().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

bool PStatThreadData::is_empty ( ) const

Returns true if the structure contains no frames, false otherwise.

Definition at line 55 of file pStatThreadData.cxx.

Referenced by PStatStripChart::compute_average_pixel_data(), PStatStripChart::update(), and PStatPianoRoll::update().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void PStatThreadData::record_new_frame ( int  frame_number,
PStatFrameData frame_data 
)

Makes room for and stores a new frame's worth of data.

Calling this function may cause old frame data to be discarded to make room, according to the amount of time set up via set_history().

The pointer will become owned by the PStatThreadData object and will be freed on destruction.

Definition at line 309 of file pStatThreadData.cxx.

References PStatFrameData::get_start(), and PStatFrameData::is_empty().

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void PStatThreadData::set_history ( float  time)

Sets the number of seconds worth of frames that will be retained by the ThreadData structure as each new frame is added.

This affects how old the oldest frame that may be queried is.

Definition at line 279 of file pStatThreadData.cxx.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations