mitkIGTLMessageFactory.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef MITKIGTLMESSAGEFACTORYH_HEADER_INCLUDED_
#define MITKIGTLMESSAGEFACTORYH_HEADER_INCLUDED_

#include "MitkOpenIGTLinkExports.h"
#include "mitkCommon.h"

#include "igtlMessageBase.h"
#include "igtlMessageHeader.h"

#include "mitkIGTLMessageCloneHandler.h"

namespace mitk {
  class MITKOPENIGTLINK_EXPORT IGTLMessageFactory : public itk::Object
  {
  public:
    mitkClassMacroItkParent(IGTLMessageFactory, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);

    typedef igtl::MessageBase::Pointer (*PointerToMessageBaseNew)();

    void AddMessageType(std::string messageTypeName,
               IGTLMessageFactory::PointerToMessageBaseNew messageTypeNewPointer,
               mitk::IGTLMessageCloneHandler::Pointer cloneHandler);

    virtual void AddMessageNewMethod(std::string messageTypeName,
              IGTLMessageFactory::PointerToMessageBaseNew messageTypeNewPointer);

    virtual IGTLMessageFactory::PointerToMessageBaseNew GetMessageTypeNewPointer(
        std::string messageTypeName);

    igtl::MessageBase::Pointer CreateInstance(std::string messageTypeName);

    igtl::MessageBase::Pointer CreateInstance(igtl::MessageHeader::Pointer msg);

    virtual void AddMessageCloneHandler(std::string msgTypeName,
                      mitk::IGTLMessageCloneHandler::Pointer msgCloneHandler);

    virtual mitk::IGTLMessageCloneHandler::Pointer
    GetCloneHandler(std::string messageTypeName);

    igtl::MessageBase::Pointer Clone(igtl::MessageBase::Pointer msg);

    std::list<std::string> GetAvailableMessageRequestTypes();

  protected:
    IGTLMessageFactory();
    ~IGTLMessageFactory() override;

    std::map<std::string,mitk::IGTLMessageCloneHandler::Pointer> m_CloneHandlers;

    std::map<std::string, PointerToMessageBaseNew> m_NewMethods;

  private:
    IGTLMessageFactory(const IGTLMessageFactory&);
  };
}

#endif