PDG_NodeStats.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
* Side Effects Software Inc., and is not to be reproduced,
* transmitted, or disclosed in any way without written permission.
*
* COMMENTS:
*/

#ifndef __PDG_NODE_STATS_H__
#define __PDG_NODE_STATS_H__

#include "PDG_API.h"
#include "PDG_Types.h"
#include "PDG_WorkItemStateTracker.h"

#include <UT/UT_TBBSpinLock.h>

/*
 * Helper class that stores node cook times and work item totals
 */
class PDG_API PDG_NodeStats
{
public:
    /// Enumeration of stats stored in this object
    enum StatType
    {
        /// The timestamp at which the node first began generating work items
        eFirstGenerateTime,

        /// The timestamp at which the node is fully generated
        eLastGenerateTime,

        /// The total time spent generating work items
        eTotalGenerateTime,

        /// The timestamp at which the node first began cooking work items
        eFirstCookTime,

        /// The timestamp at which the node is fully cooked
        eLastCookTime,

        /// The total time spent cooking work items
        eTotalCookTime,

        /// The number of different tracked node stats
        eStatCount
    };

public:
    /// Constructs a new node stat instance
                                    PDG_NodeStats();

    /// Resets all stats on the node
    void                            reset(bool full);

    /// Returns the work item state tracker for this node
    const PDG_WorkItemStateTracker& stateTracker() const
                                        { return myWorkItemStates; }
    PDG_WorkItemStateTracker&       stateTracker()
                                        { return myWorkItemStates; }

    /// Returns the number of times this node has cooked
    int                             cookCount() const
                                        { return myCookCount; }

    /// Increments the cook count and returns the old value
    int                             incrementCookCount()
                                        {
                                            int old_count = myCookCount++;
                                            return old_count;
                                        }

    /// Returns the current value of the specified stat type
    fpreal                          getStat(StatType stat) const;

    /// Sets the value of the specified stat type
    fpreal                          setStat(
                                        StatType stat,
                                        fpreal value,
                                        bool first=false);

    /// Sets te value of the specified stat to the current time
    fpreal                          setTimeStat(
                                        StatType stat,
                                        bool first=false);

    /// Adds the value to the specified state type
    fpreal                          addStat(
                                        StatType state,
                                        fpreal value,
                                        bool first=false);

    /// Returns the total time spent cooking work items in the node
    fpreal                          totalCookTime() const;

    /// Returns the wallclock cook time, e.g. the difference between the
    /// first work item starting and the last work item ending.
    fpreal                          wallclockCookTime() const;

private:
    PDG_WorkItemStateTracker        myWorkItemStates;
    fpreal                          myStats[eStatCount];
    int                             myCookCount;
    mutable UT_TBBSpinLock          myStatLock;
};

#endif