HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_PerfMonMemoryEvent Class Reference

#include <UT_PerfMonMemoryEvent.h>

+ Inheritance diagram for UT_PerfMonMemoryEvent:

Public Member Functions

 UT_PerfMonMemoryEvent (int id, const char *name, const char *object, bool auto_nest_events, UT_PerfMonCategory category, UT_PerfMonObjectType object_type, const char *object_icon=NULL, const char *extra_info=NULL, int frame_num=UT_PERFORMANCE_INVALID_FRAME)
 
virtual ~UT_PerfMonMemoryEvent ()
 
virtual void getFormattedString (UT_PerfMonLogTimeFormat time_format, UT_String &str_event) const
 Format the event into a pretty string that can be outputted in a log. More...
 
- Public Member Functions inherited from UT_PerfMonEvent
 UT_PerfMonEvent (int id, const char *name, const char *object, bool auto_nest_events, UT_PerfMonCategory category, UT_PerfMonEventType type, UT_PerfMonObjectType object_type, const char *object_icon=NULL, const char *extra_info=NULL, int frame_num=UT_PERFORMANCE_INVALID_FRAME)
 
virtual ~UT_PerfMonEvent ()
 
int id () const
 Return the unique id assigned by the performance monitor. More...
 
int frameNum () const
 Return the frame number in which the event occured. More...
 
const char * name () const
 Return the event name. More...
 
const char * object () const
 Return the object that the event applies to. More...
 
void setObject (const char *object)
 Set the object that the event applies to. More...
 
const char * objectIcon () const
 
const char * extraInfo () const
 
void setExtraInfo (const char *extra_info)
 
UT_PerfMonEventType type () const
 Return the event type. More...
 
UT_PerfMonObjectType objectType () const
 Return the event object type. More...
 
bool isAutoNestEnabled () const
 Return true if this event has automatic child event nesting enabled. More...
 
UT_PerfMonCategory category () const
 Return the category. More...
 
virtual bool isTimedEvent () const
 Return true if the event is a timed event. More...
 
void start ()
 
void stop ()
 
bool isRunning () const
 
fpreal value () const
 
fpreal selfValue () const
 
void setValue (fpreal val)
 Set the event value. More...
 
void overrideValue (fpreal value)
 
void calculateSelfValue ()
 
void appendChild (UT_PerfMonEvent *event)
 Add a child event. More...
 
void removeChild (UT_PerfMonEvent *event)
 
void removeChildren ()
 Remove all child events. More...
 
int numChildren () const
 Return the number of child events. More...
 
const UT_PerfMonEventgetChild (int index) const
 Return the child at the given index. More...
 
UT_PerfMonEventgetChild (int index)
 
void appendParent (UT_PerfMonEvent *event)
 Add a parent event. More...
 
void removeParent (UT_PerfMonEvent *event)
 
void removeParents ()
 Remove all parent events. More...
 
int numParents () const
 Return the number of parent events. More...
 
const UT_PerfMonEventgetParent (int index) const
 Return the parent at the given index. More...
 
UT_PerfMonEventgetParent (int index)
 

Protected Member Functions

virtual void subclassStart_ ()
 Perform work when the event is started. More...
 
virtual void subclassStop_ ()
 Perform work when the event is stopped. More...
 
virtual fpreal subclassCalculateSelfValue_ ()
 
virtual void subclassCollectDataFromChild_ (const UT_PerfMonEvent *child)
 
- Protected Member Functions inherited from UT_PerfMonEvent
bool isValueOverridden_ () const
 Return true if the value has been overridden. More...
 
virtual void subclassOverrideValue_ ()
 Perform work when the event's value has been overridden. More...
 
void getFormattedObjectPathAndExtraInfo_ (bool enclose_obj_path_in_parens, UT_String &object_path, UT_String &extra_info) const
 Pass back a formatted string of this event's object path and extra info. More...
 

Detailed Description

Definition at line 28 of file UT_PerfMonMemoryEvent.h.

Constructor & Destructor Documentation

UT_PerfMonMemoryEvent::UT_PerfMonMemoryEvent ( int  id,
const char *  name,
const char *  object,
bool  auto_nest_events,
UT_PerfMonCategory  category,
UT_PerfMonObjectType  object_type,
const char *  object_icon = NULL,
const char *  extra_info = NULL,
int  frame_num = UT_PERFORMANCE_INVALID_FRAME 
)
virtual UT_PerfMonMemoryEvent::~UT_PerfMonMemoryEvent ( )
virtual

Member Function Documentation

virtual void UT_PerfMonMemoryEvent::getFormattedString ( UT_PerfMonLogTimeFormat  time_format,
UT_String str_event 
) const
virtual

Format the event into a pretty string that can be outputted in a log.

Reimplemented from UT_PerfMonEvent.

virtual fpreal UT_PerfMonMemoryEvent::subclassCalculateSelfValue_ ( )
protectedvirtual

Calculate the event's self value (time). Return the self value.

Reimplemented from UT_PerfMonEvent.

virtual void UT_PerfMonMemoryEvent::subclassCollectDataFromChild_ ( const UT_PerfMonEvent child)
protectedvirtual

Collect the data from the given child event and merge it into this event's children data.

Reimplemented from UT_PerfMonEvent.

virtual void UT_PerfMonMemoryEvent::subclassStart_ ( )
protectedvirtual

Perform work when the event is started.

Reimplemented from UT_PerfMonEvent.

virtual void UT_PerfMonMemoryEvent::subclassStop_ ( )
protectedvirtual

Perform work when the event is stopped.

Reimplemented from UT_PerfMonEvent.


The documentation for this class was generated from the following file: