makVrf::DtObjectConsoleMessageHandler Class Reference

Inheritance diagram for makVrf::DtObjectConsoleMessageHandler:

Public Types
typedef std::vector< std::pair < makVrv::DtUnicode, int > >	DtConsoleMessageList

Public Member Functions
	DtObjectConsoleMessageHandler (makVrv::DtDe &)
virtual	~DtObjectConsoleMessageHandler ()
virtual void	setEnabled (bool)
bool	enabled () const
virtual void	setMessageQueueSize (int)
int	messageQueueSize () const
virtual bool	questionFor (makVrv::DtElementID id, int questionId, DtIfAskUserQuestion &) const
	Returns the question for the entity and question id. If no question exists return false.
virtual std::vector< int >	pendingQuestionsFor (makVrv::DtElementID) const
	Returns the list of pending question ids for the given entity.
virtual bool	hasOutstandingQuestions (makVrv::DtElementID) const
	Returns true if this entity has any outstanding questions.
virtual DtConsoleMessageList	messagesFor (const std::string &entityId) const
	Entity ID is the site/host/app id of the entity.
virtual void	setReceivingMessagesFor (makVrv::DtElementID, bool)
	Set the fact that there is something that is receiving messages for the given entity id.
virtual void	clearAllMessages (const std::string &entityId)
	Clears out the messages for the given entity.
virtual void	userQuestionAnswered (makVrv::DtElementID id, int questionId)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtObjectConsoleMessageHandler &	instance (makVrv::DtDe &de)
	Returns instance of the messager.
static void	registerInstance (makVrv::DtDe &de, DtObjectConsoleMessageHandler *)

Public Attributes
boost::signal< void(const DtEntityIdentifier &, int notifyLevel, const makVrv::DtUnicode &)>	signal_consoleMessageReceived
boost::signal< void(int)>	signal_messageQueueSizeChanged
boost::signal< void(makVrv::DtElementID, int, int)>	signal_questionStatusChanged

Protected Types
typedef std::map< std::string, DtConsoleMessageList >	DtConsoleMessageMap
typedef std::map< std::string, std::vector < DtIfAskUserQuestion > >	PendingQuestions

Protected Member Functions
virtual void	processObjectConsoleMessageCallback (DtNetworkMessageInterface *)
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &entry)
virtual void	processUserQuestion (DtSimMessage *)
virtual bool	processQuestion (const DtIfAskUserQuestion &)
virtual void	processUserQuestionOperation (DtSimMessage *)
virtual void	messagesToResolve ()
	Tries to map any awaiting items to ids.
virtual void	questionsToResolve ()
virtual makVrv::DtUnicode	translateComment (DtCommentInteractionInterface *comment) const
virtual void	messagesToResolve (makVrv::DtElementID)
virtual void	checkIfNeedsToNotifyForNewMessage (makVrv::DtElementID, bool isQuestion=false)

Protected Attributes
makVrv::DtDe &	myDe
bool	myEnabled
int	myMessageQueueSize
DtConsoleMessageMap	myConsoleMessageMap
std::map< makVrv::DtElementID, int >	myReceivingMessagesFor
std::map< std::string, int >	myHasAwaitingMessages
	Messages are awaiting for an object that does not have an element id yet.
std::map< std::string, DtIfAskUserQuestion >	myHasAwaitingQuestions
std::map< makVrv::DtElementID, int >	mySetAwaiting
PendingQuestions	myPendingQuestions

Member Typedef Documentation

typedef std::vector<std::pair<makVrv::DtUnicode, int> > makVrf::DtObjectConsoleMessageHandler::DtConsoleMessageList

typedef std::map<std::string, DtConsoleMessageList> makVrf::DtObjectConsoleMessageHandler::DtConsoleMessageMap

protected

typedef std::map<std::string, std::vector<DtIfAskUserQuestion> > makVrf::DtObjectConsoleMessageHandler::PendingQuestions

protected

Constructor & Destructor Documentation

makVrf::DtObjectConsoleMessageHandler::DtObjectConsoleMessageHandler

(

makVrv::DtDe &

)

virtual makVrf::DtObjectConsoleMessageHandler::~DtObjectConsoleMessageHandler ( )

virtual

Member Function Documentation

static DtObjectConsoleMessageHandler& makVrf::DtObjectConsoleMessageHandler::instance ( makVrv::DtDe &  de )

static

Returns instance of the messager.

static void makVrf::DtObjectConsoleMessageHandler::registerInstance ( makVrv::DtDe &  de, DtObjectConsoleMessageHandler *    )

static

virtual void makVrf::DtObjectConsoleMessageHandler::setEnabled ( bool  )

virtual

bool makVrf::DtObjectConsoleMessageHandler::enabled ( ) const

inline

virtual void makVrf::DtObjectConsoleMessageHandler::setMessageQueueSize ( int  )

virtual

int makVrf::DtObjectConsoleMessageHandler::messageQueueSize ( ) const

inline

virtual bool makVrf::DtObjectConsoleMessageHandler::questionFor ( makVrv::DtElementID  id, int  questionId, DtIfAskUserQuestion &    ) const

virtual

Returns the question for the entity and question id. If no question exists return false.

virtual std::vector<int> makVrf::DtObjectConsoleMessageHandler::pendingQuestionsFor ( makVrv::DtElementID  ) const

virtual

Returns the list of pending question ids for the given entity.

virtual bool makVrf::DtObjectConsoleMessageHandler::hasOutstandingQuestions ( makVrv::DtElementID  ) const

virtual

Returns true if this entity has any outstanding questions.

virtual DtConsoleMessageList makVrf::DtObjectConsoleMessageHandler::messagesFor ( const std::string &  entityId ) const

virtual

Entity ID is the site/host/app id of the entity.

virtual void makVrf::DtObjectConsoleMessageHandler::setReceivingMessagesFor ( makVrv::DtElementID  , bool    )

virtual

Set the fact that there is something that is receiving messages for the given entity id.

If there are no objects monitoring messages, a state will be set in the locked object that there are outstanding messages for this entity, and, a signal will be sent out when there are outstanding messages

virtual void makVrf::DtObjectConsoleMessageHandler::clearAllMessages ( const std::string &  entityId )

virtual

Clears out the messages for the given entity.

virtual void makVrf::DtObjectConsoleMessageHandler::userQuestionAnswered ( makVrv::DtElementID  id, int  questionId  )

virtual

virtual void makVrf::DtObjectConsoleMessageHandler::processObjectConsoleMessageCallback ( DtNetworkMessageInterface *  )

protectedvirtual

virtual void makVrf::DtObjectConsoleMessageHandler::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry &  entry )

protectedvirtual

virtual void makVrf::DtObjectConsoleMessageHandler::processUserQuestion ( DtSimMessage *  )

protectedvirtual

virtual bool makVrf::DtObjectConsoleMessageHandler::processQuestion ( const DtIfAskUserQuestion &  )

protectedvirtual

virtual void makVrf::DtObjectConsoleMessageHandler::processUserQuestionOperation ( DtSimMessage *  )

protectedvirtual

virtual void makVrf::DtObjectConsoleMessageHandler::messagesToResolve ( )

protectedvirtual

Tries to map any awaiting items to ids.

virtual void makVrf::DtObjectConsoleMessageHandler::questionsToResolve ( )

protectedvirtual

virtual makVrv::DtUnicode makVrf::DtObjectConsoleMessageHandler::translateComment ( DtCommentInteractionInterface *  comment ) const

protectedvirtual

Reimplemented in makVrf::DtQtObjectConsoleMessageHandler.

virtual void makVrf::DtObjectConsoleMessageHandler::messagesToResolve ( makVrv::DtElementID  )

protectedvirtual

virtual void makVrf::DtObjectConsoleMessageHandler::checkIfNeedsToNotifyForNewMessage ( makVrv::DtElementID  , bool  isQuestion = false  )

protectedvirtual

Member Data Documentation

boost::signal<void (const DtEntityIdentifier&, int notifyLevel, const makVrv::DtUnicode&)> makVrf::DtObjectConsoleMessageHandler::signal_consoleMessageReceived

boost::signal<void (int)> makVrf::DtObjectConsoleMessageHandler::signal_messageQueueSizeChanged

boost::signal<void (makVrv::DtElementID, int, int)> makVrf::DtObjectConsoleMessageHandler::signal_questionStatusChanged

makVrv::DtDe& makVrf::DtObjectConsoleMessageHandler::myDe

protected

bool makVrf::DtObjectConsoleMessageHandler::myEnabled

protected

int makVrf::DtObjectConsoleMessageHandler::myMessageQueueSize

protected

DtConsoleMessageMap makVrf::DtObjectConsoleMessageHandler::myConsoleMessageMap

protected

std::map<makVrv::DtElementID, int> makVrf::DtObjectConsoleMessageHandler::myReceivingMessagesFor

protected

std::map<std::string, int> makVrf::DtObjectConsoleMessageHandler::myHasAwaitingMessages

protected

Messages are awaiting for an object that does not have an element id yet.

std::map<std::string, DtIfAskUserQuestion> makVrf::DtObjectConsoleMessageHandler::myHasAwaitingQuestions

protected

std::map<makVrv::DtElementID, int> makVrf::DtObjectConsoleMessageHandler::mySetAwaiting

protected

PendingQuestions makVrf::DtObjectConsoleMessageHandler::myPendingQuestions

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfGuiCore/objectConsoleMessageHandler.h