Ogre::Profiler::ProfileInstance Class Reference

Represents an individual profile call. More...

`#include <OgreProfiler.h>`

Inheritance diagram for Ogre::Profiler::ProfileInstance:
[legend]

List of all members.

## Public Types

typedef Ogre::map< String, ProfileInstance * >::type | ProfileChildren

## Public Member Functions

| ProfileInstance (void)
virtual | ~ProfileInstance (void)
void | logResults ()
void | reset ()
bool | watchForMax (void)
bool | watchForMin (void)
bool | watchForLimit (Real limit, bool greaterThan=true)
bool | watchForMax (const String &profileName)
bool | watchForMin (const String &profileName)
bool | watchForLimit (const String &profileName, Real limit, bool greaterThan=true)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)

## Public Attributes

String | name
| The name of the profile.
ProfileInstance * | parent
| The name of the parent, null if root.
ProfileChildren | children
ProfileFrame | frame
ulong | frameNumber
ProfileHistory | history
ulong | currTime
| The time this profile was started.
ulong | accum
| Represents the total time of all child profiles to subtract from this profile.
uint | hierarchicalLvl
| The hierarchical level of this profile, 0 being the root profile.

## Friends

class | Profiler

## Detailed Description

Represents an individual profile call.

Definition at line 405 of file OgreProfiler.h.

## Member Typedef Documentation

typedef Ogre::map<String,ProfileInstance*>::type Ogre::Profiler::ProfileInstance::ProfileChildren

Definition at line 413 of file OgreProfiler.h.

## Constructor & Destructor Documentation

Ogre::Profiler::ProfileInstance::ProfileInstance | ( | void |  | ) |

virtual Ogre::Profiler::ProfileInstance::~ProfileInstance | ( | void |  | ) | `[virtual]`

## Member Function Documentation

void Ogre::Profiler::ProfileInstance::logResults | ( |  | ) |

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::Profiler::ProfileInstance::reset | ( |  | ) |

bool Ogre::Profiler::ProfileInstance::watchForLimit | ( | Real | limit,
|  | bool | greaterThan = `true`
| ) |  |

Definition at line 420 of file OgreProfiler.h.

bool Ogre::Profiler::ProfileInstance::watchForLimit | ( | const String & | profileName,
|  | Real | limit,
|  | bool | greaterThan = `true`
| ) |  |

bool Ogre::Profiler::ProfileInstance::watchForMax | ( | void |  | ) |

Definition at line 418 of file OgreProfiler.h.

bool Ogre::Profiler::ProfileInstance::watchForMax | ( | const String & | profileName | ) |

bool Ogre::Profiler::ProfileInstance::watchForMin | ( | void |  | ) |

Definition at line 419 of file OgreProfiler.h.

bool Ogre::Profiler::ProfileInstance::watchForMin | ( | const String & | profileName | ) |

## Friends And Related Function Documentation

friend class Profiler`[friend]`

Definition at line 408 of file OgreProfiler.h.

## Member Data Documentation

ulong Ogre::Profiler::ProfileInstance::accum

Represents the total time of all child profiles to subtract from this profile.

Definition at line 450 of file OgreProfiler.h.

ProfileChildren Ogre::Profiler::ProfileInstance::children

Definition at line 438 of file OgreProfiler.h.

ulong Ogre::Profiler::ProfileInstance::currTime

The time this profile was started.

Definition at line 446 of file OgreProfiler.h.

ProfileFrame Ogre::Profiler::ProfileInstance::frame

Definition at line 440 of file OgreProfiler.h.

ulong Ogre::Profiler::ProfileInstance::frameNumber

Definition at line 441 of file OgreProfiler.h.

uint Ogre::Profiler::ProfileInstance::hierarchicalLvl

The hierarchical level of this profile, 0 being the root profile.

Definition at line 453 of file OgreProfiler.h.

ProfileHistory Ogre::Profiler::ProfileInstance::history

Definition at line 443 of file OgreProfiler.h.

String Ogre::Profiler::ProfileInstance::name

The name of the profile.

Definition at line 433 of file OgreProfiler.h.

ProfileInstance* Ogre::Profiler::ProfileInstance::parent

The name of the parent, null if root.

Definition at line 436 of file OgreProfiler.h.

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

- OgreProfiler.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:34