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
|
/*=========================================================================
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 __igtlStringMessage_h
#define __igtlStringMessage_h
#include <string>
#include "igtlObject.h"
#include "igtlMath.h"
#include "igtlMessageBase.h"
#include "igtlTypes.h"
#define IGTL_STRING_MESSAGE_DEFAULT_ENCODING 3 /* Default encoding -- ANSI-X3.5-1968 */
namespace igtl
{
/// THe STRING message type is used for transferring a character string. It supports character strings up to 65535 bytes.
class IGTLCommon_EXPORT StringMessage: public MessageBase
{
public:
typedef StringMessage Self;
typedef MessageBase Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
igtlTypeMacro(igtl::StringMessage, igtl::MessageBase);
igtlNewMacro(igtl::StringMessage);
public:
/// Sets the string by character array.
int SetString(const char* string);
/// Sets the string by std::string.
int SetString(const std::string & string);
/// Sets the encoding of the string. For character encoding, please refer IANA Character Sets
/// (http://www.iana.org/assignments/character-sets).
/// US-ASCII (ANSI-X3.4-1968; MIBenum = 3) is strongly recommended.
int SetEncoding(igtlUint16 enc);
/// Gets the string.
const char* GetString();
/// Gets the encoding of the string. The returned value is defined in
/// IANA Character Sets (http://www.iana.org/assignments/character-sets).
igtlUint16 GetEncoding();
protected:
StringMessage();
~StringMessage();
protected:
virtual int CalculateContentBufferSize();
virtual int PackContent();
virtual int UnpackContent();
/// The encoding of the string.
/// The value is defined in IANA Character Sets (http://www.iana.org/assignments/character-sets).
igtlUint16 m_Encoding;
/// The string.
std::string m_String;
};
} // namespace igtl
#endif // _igtlStringMessage_h
|
