igtlMessageFactory.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   The OpenIGTLink Library
  Language:  C++
  Web page:  http://openigtlink.org/
 
  Copyright (c) Insight Software Consortium. All rights reserved.
 
  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef __igtlMessageFactory_h
#define __igtlMessageFactory_h
 
#include "igtlMacro.h"
#include "igtlMessageBase.h"
#include "igtlMessageHeader.h"
#include "igtlObject.h"
#include "igtl_header.h"
 
#include <map>
 
namespace igtl
{
 
class IGTLCommon_EXPORT MessageFactory: public Object
{
public:
 
  typedef MessageFactory            Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
 
  igtlTypeMacro(MessageFactory, Object)
  igtlNewMacro(MessageFactory);
 
  typedef igtl::MessageBase::Pointer (*PointerToMessageBaseNew)(); 
 
  virtual void AddMessageType(const std::string& messageTypeName, MessageFactory::PointerToMessageBaseNew messageTypeNewPointer);
 
  virtual MessageFactory::PointerToMessageBaseNew GetMessageTypeNewPointer(const std::string& messageTypeName) const; 
 
  bool IsValid(igtl::MessageHeader::Pointer headerMsg);
 
  bool IsValid(igtl::MessageHeader::Pointer headerMsg) const;
 
  igtl::MessageBase::Pointer GetMessage(igtl::MessageHeader::Pointer headerMsg);
 
  igtl::MessageHeader::Pointer CreateHeaderMessage(int headerVersion) const;
 
  igtl::MessageBase::Pointer CreateReceiveMessage(igtl::MessageHeader::Pointer headerMsg) const;
 
  igtl::MessageBase::Pointer CreateSendMessage(const std::string& messageType, int headerVersion) const;
 
  void GetAvailableMessageTypes(std::vector<std::string>& types) const;
 
protected:
  MessageFactory();
  ~MessageFactory();
 
private:
  std::map<std::string, PointerToMessageBaseNew> IgtlMessageTypes; 
 
}; // end class
 
} // end namespace
 
#endif // __igtlMessageFactory_h