libqi-api  2.4.3.28
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
qi::Manageable Class Reference

#include <manageable.hpp>

Public Types

typedef std::map< unsigned int,
std::pair< AnyFunction,
MetaCallType > > 
MethodMap
 
typedef boost::function
< SignalBase *(void *)> 
SignalGetter
 
typedef std::map< unsigned int,
SignalGetter > 
SignalMap
 

Public Member Functions

 Manageable ()
 
 ~Manageable ()
 
 Manageable (const Manageable &b)
 
void operator= (const Manageable &b)
 
boost::mutex & initMutex ()
 
void forceExecutionContext (boost::shared_ptr< ExecutionContext > eventLoop)
 Override all ThreadingModel and force dispatch to given event loop. More...
 
boost::shared_ptr
< ExecutionContext > 
executionContext () const
 
int _nextTraceId ()
 

Static Public Member Functions

static MethodMap & manageableMmethodMap ()
 
static SignalMap & manageableSignalMap ()
 
static MetaObject & manageableMetaObject ()
 
static void _build ()
 

Public Attributes

SignalMap signalMap
 
boost::scoped_ptr
< ManageablePrivate > 
_p
 

Static Public Attributes

static const uint32_t startId = 80
 Starting id of features handled by Manageable. More...
 
static const uint32_t endId = 99
 Stop id of features handled by Manageable. More...
 
Signal< EventTrace > traceObject
 Emitted each time a call starts and finishes, and for each signal trigger. More...
 
bool isStatsEnabled () const
 
void enableStats (bool enable)
 Set statistics gathering status. More...
 
void pushStats (int slotId, float wallTime, float userTime, float systemTime)
 Push statistics information about slotId. More...
 
ObjectStatistics stats () const
 
void clearStats ()
 Reset all statistical data. More...
 
bool isTraceEnabled () const
 
void enableTrace (bool enable)
 

Detailed Description

Per-instance context.

Definition at line 120 of file manageable.hpp.

Member Typedef Documentation

typedef std::map<unsigned int, std::pair<AnyFunction, MetaCallType> > qi::Manageable::MethodMap

Definition at line 173 of file manageable.hpp.

typedef boost::function<SignalBase* (void*)> qi::Manageable::SignalGetter

Definition at line 174 of file manageable.hpp.

typedef std::map<unsigned int, SignalGetter> qi::Manageable::SignalMap

Definition at line 175 of file manageable.hpp.

Constructor & Destructor Documentation

qi::Manageable::Manageable ( )
qi::Manageable::~Manageable ( )
qi::Manageable::Manageable ( const Manageable &  b)

Member Function Documentation

static void qi::Manageable::_build ( )
static
int qi::Manageable::_nextTraceId ( )
void qi::Manageable::clearStats ( )

Reset all statistical data.

void qi::Manageable::enableStats ( bool  enable)

Set statistics gathering status.

void qi::Manageable::enableTrace ( bool  enable)

Set trace mode state.

Warning
This function should usually not be called directly. Connecting/disconnecting to the traceObject signal automatically enables/disables tracing mode.

When enabled, all calls and signal triggers will be reported through the "traceObject" signal.

boost::shared_ptr<ExecutionContext> qi::Manageable::executionContext ( ) const
Returns
forced event loop or 0 if not set
void qi::Manageable::forceExecutionContext ( boost::shared_ptr< ExecutionContext >  eventLoop)

Override all ThreadingModel and force dispatch to given event loop.

boost::mutex& qi::Manageable::initMutex ( )
bool qi::Manageable::isStatsEnabled ( ) const

Statistics gathering/retreiving API

Returns
if statistics gatehering is enabled
bool qi::Manageable::isTraceEnabled ( ) const
Returns
if trace mode is enabled
static MetaObject& qi::Manageable::manageableMetaObject ( )
static
static MethodMap& qi::Manageable::manageableMmethodMap ( )
static
static SignalMap& qi::Manageable::manageableSignalMap ( )
static
void qi::Manageable::operator= ( const Manageable &  b)
void qi::Manageable::pushStats ( int  slotId,
float  wallTime,
float  userTime,
float  systemTime 
)

Push statistics information about slotId.

ObjectStatistics qi::Manageable::stats ( ) const

Member Data Documentation

boost::scoped_ptr<ManageablePrivate> qi::Manageable::_p

Definition at line 185 of file manageable.hpp.

const uint32_t qi::Manageable::endId = 99
static

Stop id of features handled by Manageable.

Definition at line 170 of file manageable.hpp.

SignalMap qi::Manageable::signalMap

Definition at line 176 of file manageable.hpp.

const uint32_t qi::Manageable::startId = 80
static

Starting id of features handled by Manageable.

Definition at line 168 of file manageable.hpp.

Signal<EventTrace> qi::Manageable::traceObject

Emitted each time a call starts and finishes, and for each signal trigger.

Definition at line 150 of file manageable.hpp.


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