UT_PerfMonMemoryEvent.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.
 *
 * NAME:        UT_PerfMonMemoryEvent.h (UT Library, C++)
 *
 * COMMENTS:
 *
 *              Performance monitor memory event.
 */

#ifndef __UT_PerfMonMemoryEvent__
#define __UT_PerfMonMemoryEvent__

#include "UT_API.h"

#include <SYS/SYS_Time.h>
#include "UT_PerfMonEvent.h"
#include "UT_PerfMonTypes.h"
#include "UT_String.h"
#include "UT_Thread.h"
#include "UT_ThreadSpecificValue.h"
#include "UT_PerfMonUtils.h"

class UT_API UT_PerfMonMemoryEvent : public UT_PerfMonEvent
{
public:
    UT_PerfMonMemoryEvent(
            int id,
            const UT_StringHolder &name,
            const UT_StringHolder &object,
            bool auto_nest_events,
            UT_PerfMonCategory category,
            UT_PerfMonObjectType object_type,
            const UT_StringHolder &object_icon = UT_StringHolder::theEmptyString,
            const UT_StringHolder &extra_info = UT_StringHolder::theEmptyString,
            int frame_num = UT_PERFORMANCE_INVALID_FRAME);
    ~UT_PerfMonMemoryEvent() override;

    /// Format the event into a pretty string that can be outputted in a log.
    void                         getFormattedString(
                                    UT_PerfMonLogTimeFormat time_format,
                                    UT_String &str_event) const override;

protected:

    /// Perform work when the event is started.
    void                         subclassStart_() override;

    /// Perform work when the event is stopped.
    void                         subclassStop_() override;

    /// Calculate the event's self value (time).
    /// Return the self value.
    fpreal                       subclassCalculateSelfValue_() override;

    /// Collect the data from the given child event and merge it into this
    /// event's children data.
    void                         subclassCollectDataFromChild_(
                                    const UT_PerfMonEvent *child) override;

private:

    /// Pass back a formatted string of this (frame) event.
    void                         getFormattedFrameEventString_(
                                    UT_String &str_event) const;

    /// Pass back a formatted string of this (non-frame) event.
    void                         getFormattedEventString_(
                                    UT_String &str_event) const;

    size_t                       myStartMemoryUsage;
    size_t                       myStopMemoryUsage;
    size_t                       myChildrenMemoryUsage;
};

#endif