1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*=========================================================================
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);
/*! Function pointer for storing New() static methods of igtl::MessageBase classes */
typedef igtl::MessageBase::Pointer (*PointerToMessageBaseNew)();
/// Add message type name and pointer to IGTL message new function
/// Usage: AddMessageType( "IMAGE", (PointerToMessageBaseNew)&igtl::ImageMessage::New );
/// \param messageTypeName The name of the message type
/// \param messageTypeNewPointer Function pointer to the message type new function (e.g. (PointerToMessageBaseNew)&igtl::ImageMessage::New )
virtual void AddMessageType(const std::string& messageTypeName, MessageFactory::PointerToMessageBaseNew messageTypeNewPointer);
/// Get pointer to message type new function, or NULL if the message type not registered
/// Usage: igtl::MessageBase::Pointer message = GetMessageTypeNewPointer("IMAGE")();
/// Throws invalid_argument if message type is not found
virtual MessageFactory::PointerToMessageBaseNew GetMessageTypeNewPointer(const std::string& messageTypeName) const;
/// Checks that headerMsg is not null and the headerMsg->GetDeviceType() refers to a valid type, returning true if valid, and false otherwise.
bool IsValid(igtl::MessageHeader::Pointer headerMsg);
/// Checks that headerMsg is not null and the headerMsg->GetDeviceType() refers to a valid type, returning true if valid, and false otherwise.
bool IsValid(igtl::MessageHeader::Pointer headerMsg) const;
/// LEGACY method, use CreateReceiveMessage instead
/// Constructs a message from the given header.
/// Throws invalid_argument if headerMsg is NULL.
/// Throws invalid_argument if this->IsValid(headerMsg) returns false.
/// Creates message, sets header onto message and calls AllocateBuffer() on the message.
igtl::MessageBase::Pointer GetMessage(igtl::MessageHeader::Pointer headerMsg);
/// Constructs a message header.
/// Throws invalid_argument if headerMsg is NULL.
/// Throws invalid_argument if this->IsValid(headerMsg) returns false.
/// Creates message, calls InitBuffer()
igtl::MessageHeader::Pointer CreateHeaderMessage(int headerVersion) const;
/// Constructs a message from the given populated header.
/// Throws invalid_argument if headerMsg is NULL.
/// Throws invalid_argument if this->IsValid(headerMsg) returns false.
/// Creates message, sets header onto message and calls AllocatePack() on the message.
igtl::MessageBase::Pointer CreateReceiveMessage(igtl::MessageHeader::Pointer headerMsg) const;
/// Constructs an empty message from the given message type.
/// Throws invalid_argument if messageType is empty.
/// Creates message, sets header onto message and calls AllocatePack() on the message.
igtl::MessageBase::Pointer CreateSendMessage(const std::string& messageType, int headerVersion) const;
/// Return the list of known message types
void GetAvailableMessageTypes(std::vector<std::string>& types) const;
protected:
MessageFactory();
~MessageFactory();
private:
/*! Map igt message types and the New() static methods of igtl::MessageBase classes */
std::map<std::string, PointerToMessageBaseNew> IgtlMessageTypes;
}; // end class
} // end namespace
#endif // __igtlMessageFactory_h
|
