DtObjectConsoleManager Class Reference

This class represents a collection of object consoles that will be used to manage streams for individual objects.

Related Examples

• Add Simulation Command Example

Classes
struct	ObjectConsole

Public Member Functions
	DtObjectConsoleManager (DtSimulationServices *services)
virtual	~DtObjectConsoleManager ()
virtual bool	init ()
virtual void	setNotifyLevel (const DtUUID &, DtNotifyLevelType level)
virtual void	setNotifyLevel (const DtUUID &, const DtString &channel, DtNotifyLevelType level)
virtual DtNotifyLevelType	notifyLevel (const DtUUID &) const
virtual void	printToFile (const DtUUID &, const DtFilename &filename) const
virtual void	stopPrintingToFile (const DtUUID &) const
virtual void	addConsolePrinter (const DtUUID &, DtPrinter *printer)
virtual void	addAndManageConsolePrinter (const DtUUID &, DtPrinter *printer)
virtual void	removeConsolePrinter (const DtUUID &, DtPrinter *printer)
virtual const DtObjectConsole *	objectConsole (const DtUUID &) const
virtual DtObjectConsole *	objectConsole (const DtUUID &)
virtual DtOutputStream &	debugStream (const DtUUID &, const DtString &channel="") const
virtual DtOutputStream &	verboseStream (const DtUUID &, const DtString &channel="") const
virtual DtOutputStream &	infoStream (const DtUUID &, const DtString &channel="") const
virtual DtOutputStream &	warnStream (const DtUUID &, const DtString &channel="") const
virtual DtOutputStream &	errorStream (const DtUUID &, const DtString &channel="") const

Static Public Member Functions
static void	setDefaultNotifyLevel (int level)
static int	defaultNotifyLevel ()

Protected Types
typedef std::unordered_map < DtUUID, ObjectConsole >	ObjectConsoles

Protected Member Functions
virtual void	simObjectDeleted (const DtSimObject *)
virtual DtObjectConsole *	getOrCreateObjectConsole (const DtUUID &)

Protected Attributes
DtSimulationServices *	mySimulationServices
tbb::spin_rw_mutex	myMutex
ObjectConsoles	myObjectConsoles

Static Protected Attributes
static int	theDefaultNotifyLevel

Private Member Functions
	DtObjectConsoleManager ()
	DtObjectConsoleManager (const DtObjectConsole &orig)
DtObjectConsoleManager &	operator= (const DtObjectConsole &orig)

Member Typedef Documentation

typedef std::unordered_map<DtUUID,ObjectConsole> DtObjectConsoleManager::ObjectConsoles

protected

Constructor & Destructor Documentation

DtObjectConsoleManager::DtObjectConsoleManager

(

DtSimulationServices *

services

)

virtual DtObjectConsoleManager::~DtObjectConsoleManager ( )

virtual

DtObjectConsoleManager::DtObjectConsoleManager ( )

private

Not Implemented.

DtObjectConsoleManager::DtObjectConsoleManager ( const DtObjectConsole &  orig )

private

Not Implemented.

Member Function Documentation

virtual bool DtObjectConsoleManager::init ( )

virtual

Initialized the console. Calls addDefaultPrinters() to add some default printers.

virtual void DtObjectConsoleManager::setNotifyLevel ( const DtUUID &  , DtNotifyLevelType  level  )

virtual

Sets the notify level for all streams managed by this console manager.

virtual void DtObjectConsoleManager::setNotifyLevel ( const DtUUID &  , const DtString &  channel, DtNotifyLevelType  level  )

virtual

virtual DtNotifyLevelType DtObjectConsoleManager::notifyLevel ( const DtUUID &  ) const

virtual

Returns

The current notification level.

virtual void DtObjectConsoleManager::printToFile ( const DtUUID &  , const DtFilename &  filename  ) const

virtual

Starts printing the output of this object console to the specified file. Only one file will be printed to at a time. If a file is already being printed to, it will be stopped and printing will start to the new file.

virtual void DtObjectConsoleManager::stopPrintingToFile ( const DtUUID &  ) const

virtual

Stops printing to a file, if file printing is active.

virtual DtOutputStream& DtObjectConsoleManager::debugStream ( const DtUUID &  , const DtString &  channel = ""  ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtObjectConsoleManager::verboseStream ( const DtUUID &  , const DtString &  channel = ""  ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtObjectConsoleManager::infoStream ( const DtUUID &  , const DtString &  channel = ""  ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtObjectConsoleManager::warnStream ( const DtUUID &  , const DtString &  channel = ""  ) const

virtual

Returns

The stream that is routed to the object's console.

virtual DtOutputStream& DtObjectConsoleManager::errorStream ( const DtUUID &  , const DtString &  channel = ""  ) const

virtual

Returns

The stream that is routed to the object's console.

virtual void DtObjectConsoleManager::addConsolePrinter ( const DtUUID &  , DtPrinter *  printer  )

virtual

Adds the specified printer to all the streams associated with this console. The console does not take any ownership of this printer.

virtual void DtObjectConsoleManager::addAndManageConsolePrinter ( const DtUUID &  , DtPrinter *  printer  )

virtual

Adds the specified printer, using addConsolePrinter(), but also takes ownership of the printer and deletes it when this console is deleted.

Note

Printers added in this way must not be shared between more than one object console, since each one will try to delete the printer.

virtual void DtObjectConsoleManager::removeConsolePrinter ( const DtUUID &  , DtPrinter *  printer  )

virtual

Removed the specified printer from all the streams associated with this console.

virtual const DtObjectConsole* DtObjectConsoleManager::objectConsole ( const DtUUID &  ) const

virtual

Returns the actual object console for the given uuid. If doesn't exist will create.

virtual DtObjectConsole* DtObjectConsoleManager::objectConsole ( const DtUUID &  )

virtual

static void DtObjectConsoleManager::setDefaultNotifyLevel ( int  level )

static

Sets the notify level for all object consoles.

static int DtObjectConsoleManager::defaultNotifyLevel ( )

static

Returns

The current default notification level.

virtual void DtObjectConsoleManager::simObjectDeleted ( const DtSimObject *  )

protectedvirtual

virtual DtObjectConsole* DtObjectConsoleManager::getOrCreateObjectConsole ( const DtUUID &  )

protectedvirtual

DtObjectConsoleManager& DtObjectConsoleManager::operator= ( const DtObjectConsole &  orig )

private

Not Implemented.

Member Data Documentation

DtSimulationServices* DtObjectConsoleManager::mySimulationServices

protected

tbb::spin_rw_mutex DtObjectConsoleManager::myMutex

mutableprotected

ObjectConsoles DtObjectConsoleManager::myObjectConsoles

mutableprotected

int DtObjectConsoleManager::theDefaultNotifyLevel

staticprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/objectConsoleManager.h