vtkMRMLMessageCollection.h File Reference

#include "vtkMRML.h"
#include <vtkCallbackCommand.h>
#include <vtkIdTypeArray.h>
#include <string>
#include <vector>

Include dependency graph for vtkMRMLMessageCollection.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	vtkMRMLMessageCollection::Message
	A helper class that describes a single message. More...
class	vtkMRMLMessageCollection

Macros
#define	vtkErrorToMessageCollectionMacro(messageCollection, devMsgPrefix, userMsg)
#define	vtkErrorToMessageCollectionWithObjectMacro(self, messageCollection, devMsgPrefix, userMsg)
#define	vtkWarningToMessageCollectionMacro(messageCollection, devMsgPrefix, userMsg)
#define	vtkWarningToMessageCollectionWithObjectMacro(self, messageCollection, devMsgPrefix, userMsg)

Macro Definition Documentation

vtkErrorToMessageCollectionMacro

#define vtkErrorToMessageCollectionMacro	(		messageCollection,
			devMsgPrefix,
			userMsg )

Value:

vtkErrorToMessageCollectionWithObjectMacro(this, messageCollection, devMsgPrefix, userMsg)

Definition at line 44 of file vtkMRMLMessageCollection.h.

vtkErrorToMessageCollectionWithObjectMacro

#define vtkErrorToMessageCollectionWithObjectMacro	(		self,
			messageCollection,
			devMsgPrefix,
			userMsg )

Value:

   {                                                                                                \
     vtkOStreamWrapper::EndlType endl;                                                              \
     vtkOStreamWrapper::UseEndl(endl);                                                              \
     if (messageCollection)                                                                         \
     {                                                                                              \
       vtkOStrStreamWrapper userMsgStream;                                                          \
       userMsgStream << userMsg;                                                                    \
       messageCollection->AddMessage(vtkCommand::ErrorEvent, userMsgStream.str());                  \
       userMsgStream.rdbuf()->freeze(0);                                                            \
     }                                                                                              \
     vtkErrorWithObjectMacro(self, << devMsgPrefix << ": " << userMsg);                             \
   }

Definition at line 64 of file vtkMRMLMessageCollection.h.

vtkWarningToMessageCollectionMacro

#define vtkWarningToMessageCollectionMacro	(		messageCollection,
			devMsgPrefix,
			userMsg )

Value:

vtkWarningToMessageCollectionWithObjectMacro(this, messageCollection, devMsgPrefix, userMsg)

Macros to log warning or error message (for developers) and also add a message to the input message collection (to be displayed to the user later).

Definition at line 40 of file vtkMRMLMessageCollection.h.

vtkWarningToMessageCollectionWithObjectMacro

#define vtkWarningToMessageCollectionWithObjectMacro	(		self,
			messageCollection,
			devMsgPrefix,
			userMsg )

Value:

   {                                                                                                  \
     vtkOStreamWrapper::EndlType endl;                                                                \
     vtkOStreamWrapper::UseEndl(endl);                                                                \
     if (messageCollection)                                                                           \
     {                                                                                                \
       vtkOStrStreamWrapper userMsgStream;                                                            \
       userMsgStream << userMsg;                                                                      \
       messageCollection->AddMessage(vtkCommand::WarningEvent, userMsgStream.str());                  \
       userMsgStream.rdbuf()->freeze(0);                                                              \
     }                                                                                                \
     vtkWarningWithObjectMacro(self, << devMsgPrefix << ": " << userMsg);                             \
   }

Definition at line 48 of file vtkMRMLMessageCollection.h.