PDG_WorkItemStats.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_WORKITEMSTATS_H__
#define __PDG_WORKITEMSTATS_H__

#include "PDG_API.h"

#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>

/*
 * Helper struct for storing basic work item stats, like cook times and
 * output file size
 */
class PDG_API PDG_WorkItemStats
{
public:
    /// Enumeration of stats stored in this object
    enum StatType
    {
        /// The time at which the work item was submitted to the PDG
        /// scheduler queue
        eQueueTime,

        /// The time at which the work item was passed to the
        /// onSchedule call for the active scheduler
        eScheduleTime,

        /// The time at which the work item began cooking. For scheduled
        /// items, this is set when the startCook message is recevied, not
        /// when the item is scheduled.
        eCookStartTime,

        /// The time at which the work item completed cooking.
        eCookEndTime,

        /// The total file size of all outputs on the work item
        eFileSize,

        /// The number of tracked stats
        eStatCount
    };

public:
    /// Constructs and zero-initializes the stat object
                            PDG_WorkItemStats();

    /// Resets all stats on the work item
    void                    reset();

    /// 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);

    /// Sets the value of the specified stat to the current time
    fpreal                  setTimeStat(StatType stat);

    /// Returns the cook duration for the work item. e.g. the time spent
    /// between starting and stopping cooking
    fpreal                  cookDuration() const;

    /// Sets the service client used to cook the work item
    void                    setServiceClient(const UT_StringHolder& client)
                                { myServiceClient = client; }

    /// Returns the service client name used to cook this work item, or empty
    /// string if the work item didn't cook using services
    const UT_StringHolder&  serviceClient() const
                                { return myServiceClient; }

private:
    fpreal                  myStats[eStatCount];
    UT_StringHolder         myServiceClient;
};

#endif