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

#include <aggregateNode.h>

+ Inheritance diagram for TraceAggregateNode:

Classes

class  Id
 

Public Types

using This = TraceAggregateNode
 
using ThisPtr = TraceAggregateNodePtr
 
using ThisRefPtr = TraceAggregateNodeRefPtr
 
using TimeStamp = TraceEvent::TimeStamp
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 

Public Member Functions

TRACE_API TraceAggregateNodeRefPtr Append (Id id, const TfToken &key, TimeStamp ts, int c=1, int xc=1)
 
TRACE_API void Append (TraceAggregateNodeRefPtr child)
 
TfToken GetKey ()
 Returns the node's key. More...
 
const IdGetId ()
 Returns the node's id. More...
 
TRACE_API void CalculateInclusiveCounterValues ()
 
void SetExpanded (bool expanded)
 Sets whether or not this node is expanded in a gui. More...
 
bool IsExpanded ()
 Returns whether this node is expanded in a gui. More...
 
Profile Data Accessors
TimeStamp GetInclusiveTime ()
 Returns the total time of this node ands its children. More...
 
TRACE_API TimeStamp GetExclusiveTime (bool recursive=false)
 Returns the time spent in this node but not its children. More...
 
int GetCount (bool recursive=false) const
 
int GetExclusiveCount () const
 Returns the exclusive count. More...
 
Counter Value Accessors
TRACE_API void AppendInclusiveCounterValue (int index, double value)
 
TRACE_API double GetInclusiveCounterValue (int index) const
 
TRACE_API void AppendExclusiveCounterValue (int index, double value)
 
TRACE_API double GetExclusiveCounterValue (int index) const
 
Children Accessors
const TraceAggregateNodePtrVector GetChildren ()
 
const
TraceAggregateNodeRefPtrVector & 
GetChildrenRef ()
 
TRACE_API TraceAggregateNodeRefPtr GetChild (const TfToken &key)
 
TraceAggregateNodeRefPtr GetChild (const std::string &key)
 
Recursion
TRACE_API void MarkRecursiveChildren ()
 
bool IsRecursionMarker () const
 
bool IsRecursionHead () const
 
- Public Member Functions inherited from TfRefBase
 TfRefBase ()
 
size_t GetCurrentCount () const
 Return the current reference count of this object. More...
 
bool IsUnique () const
 Return true if only one TfRefPtr points to this object. More...
 
const TfRefCountGetRefCount () const
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void constGetUniqueIdentifier () const
 

Static Public Member Functions

static ThisRefPtr New ()
 
static ThisRefPtr New (const Id &id, const TfToken &key, const TimeStamp ts, const int count=1, const int exclusiveCount=1)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Additional Inherited Members

- Protected Member Functions inherited from TfRefBase
virtual TF_API ~TfRefBase ()
 
- Protected Member Functions inherited from TfWeakBase
 ~TfWeakBase ()
 
TfRefPtr< Tf_Remnant_Register () const
 
template<class T >
TfRefPtr< Tf_Remnant_Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Detailed Description

A representation of a call tree. Each node represents one or more calls that occurred in the trace. Multiple calls to a child node are aggregated into one node.

Definition at line 57 of file aggregateNode.h.

Member Typedef Documentation

Definition at line 60 of file aggregateNode.h.

using TraceAggregateNode::ThisPtr = TraceAggregateNodePtr

Definition at line 61 of file aggregateNode.h.

using TraceAggregateNode::ThisRefPtr = TraceAggregateNodeRefPtr

Definition at line 62 of file aggregateNode.h.

Member Function Documentation

TRACE_API TraceAggregateNodeRefPtr TraceAggregateNode::Append ( Id  id,
const TfToken key,
TimeStamp  ts,
int  c = 1,
int  xc = 1 
)
TRACE_API void TraceAggregateNode::Append ( TraceAggregateNodeRefPtr  child)
TRACE_API void TraceAggregateNode::AppendExclusiveCounterValue ( int  index,
double  value 
)
TRACE_API void TraceAggregateNode::AppendInclusiveCounterValue ( int  index,
double  value 
)
TRACE_API void TraceAggregateNode::CalculateInclusiveCounterValues ( )

Recursively calculates the inclusive counter values from the inclusive and exclusive counts of child nodes.

TRACE_API TraceAggregateNodeRefPtr TraceAggregateNode::GetChild ( const TfToken key)
TraceAggregateNodeRefPtr TraceAggregateNode::GetChild ( const std::string key)
inline

Definition at line 153 of file aggregateNode.h.

const TraceAggregateNodePtrVector TraceAggregateNode::GetChildren ( )
inline

Definition at line 143 of file aggregateNode.h.

const TraceAggregateNodeRefPtrVector& TraceAggregateNode::GetChildrenRef ( )
inline

Definition at line 148 of file aggregateNode.h.

int TraceAggregateNode::GetCount ( bool  recursive = false) const
inline

Returns the call count of this node. recursive determines if recursive calls are counted.

Definition at line 113 of file aggregateNode.h.

int TraceAggregateNode::GetExclusiveCount ( ) const
inline

Returns the exclusive count.

Definition at line 118 of file aggregateNode.h.

TRACE_API double TraceAggregateNode::GetExclusiveCounterValue ( int  index) const
TRACE_API TimeStamp TraceAggregateNode::GetExclusiveTime ( bool  recursive = false)

Returns the time spent in this node but not its children.

const Id& TraceAggregateNode::GetId ( )
inline

Returns the node's id.

Definition at line 100 of file aggregateNode.h.

TRACE_API double TraceAggregateNode::GetInclusiveCounterValue ( int  index) const
TimeStamp TraceAggregateNode::GetInclusiveTime ( )
inline

Returns the total time of this node ands its children.

Definition at line 106 of file aggregateNode.h.

TfToken TraceAggregateNode::GetKey ( )
inline

Returns the node's key.

Definition at line 97 of file aggregateNode.h.

bool TraceAggregateNode::IsExpanded ( )
inline

Returns whether this node is expanded in a gui.

Definition at line 166 of file aggregateNode.h.

bool TraceAggregateNode::IsRecursionHead ( ) const
inline

Returns true if this node is the head of a recursive call tree (i.e. the function has been called recursively).

This value is meaningless until this node or any of its ancestors have been marked with MarkRecursiveChildren().

Definition at line 192 of file aggregateNode.h.

bool TraceAggregateNode::IsRecursionMarker ( ) const
inline

Returns true if this node is simply a marker for a merged recursive subtree; otherwise returns false.

This value is meaningless until this node or any of its ancestors have been marked with MarkRecursiveChildren().

Definition at line 185 of file aggregateNode.h.

TRACE_API void TraceAggregateNode::MarkRecursiveChildren ( )

Scans the tree for recursive calls and updates the recursive counts.

This call leaves the tree topology intact, and only updates the recursion-related data in the node. Prior to this call, recursion data is invalid in the node.

static ThisRefPtr TraceAggregateNode::New ( )
inlinestatic

Definition at line 78 of file aggregateNode.h.

static ThisRefPtr TraceAggregateNode::New ( const Id id,
const TfToken key,
const TimeStamp  ts,
const int  count = 1,
const int  exclusiveCount = 1 
)
inlinestatic

Definition at line 82 of file aggregateNode.h.

void TraceAggregateNode::SetExpanded ( bool  expanded)
inline

Sets whether or not this node is expanded in a gui.

Definition at line 161 of file aggregateNode.h.


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