vtkMRMLMessageCollection.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Lee Newberg, Kitware Inc.

==============================================================================*/

#ifndef __vtkMRMLMessageCollection_h
#define __vtkMRMLMessageCollection_h

// MRML includes
#include "vtkMRML.h"

// VTK includes
#include <vtkCallbackCommand.h>
#include <vtkIdTypeArray.h>

// STD includes
#include <string>
#include <vector>


#ifndef vtkWarningToMessageCollectionMacro
#define vtkWarningToMessageCollectionMacro(messageCollection, devMsgPrefix, userMsg) \
  vtkWarningToMessageCollectionWithObjectMacro(this, messageCollection, devMsgPrefix, userMsg)
#endif

#ifndef vtkErrorToMessageCollectionMacro
#define vtkErrorToMessageCollectionMacro(messageCollection, devMsgPrefix, userMsg) \
  vtkErrorToMessageCollectionWithObjectMacro(this, messageCollection, devMsgPrefix, userMsg)
#endif

#ifndef vtkWarningToMessageCollectionWithObjectMacro
#define vtkWarningToMessageCollectionWithObjectMacro(self, messageCollection, devMsgPrefix, userMsg) \
  {                                                          \
  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);   \
  }
#endif

#ifndef vtkErrorToMessageCollectionWithObjectMacro
#define vtkErrorToMessageCollectionWithObjectMacro(self, messageCollection, devMsgPrefix, userMsg) \
  {                                                          \
  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);   \
  }
#endif


class VTK_MRML_EXPORT vtkMRMLMessageCollection : public vtkObject
{
public:
  vtkTypeMacro(vtkMRMLMessageCollection,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkMRMLMessageCollection* New();

  virtual int GetNumberOfMessages() const;

  virtual int GetNumberOfMessagesOfType(unsigned long messageType) const;

  virtual int GetNumberOfMessagesOfType(const char *eventName) const;

  virtual unsigned long GetNthMessageType(int index) const;

  virtual std::string GetNthMessageText(int index) const;

  virtual void AddMessage(unsigned long messageType, const std::string &messageText);

  virtual void AddSeparator();

  virtual void AddMessages(vtkMRMLMessageCollection* source, const std::string& prefix=std::string());

  virtual void ClearMessages();

  virtual void DeepCopy(vtkMRMLMessageCollection* source);

  virtual std::string GetAllMessagesAsString(bool* errorFound=nullptr, bool* warningFound=nullptr);

  virtual void SetObservedObject(vtkObject* observedObject);

protected:
  vtkMRMLMessageCollection();
  ~vtkMRMLMessageCollection() override;
  vtkMRMLMessageCollection(const vtkMRMLMessageCollection&);
  void operator=(const vtkMRMLMessageCollection&);

  struct VTK_MRML_EXPORT Message
    {
    Message(unsigned long messageType, const std::string &messageText);

    unsigned long MessageType;
    std::string MessageText;
    };

  static void CallbackFunction(vtkObject*, long unsigned int,
    void* clientData, void* callData);

  vtkSmartPointer<vtkObject> ObservedObject;
  vtkSmartPointer<vtkCallbackCommand> CallbackCommand;
  std::vector<Message> Messages;
};

#endif