OnixS C++ SGX Titan ITCH Market Data Handler  1.2.2
API documentation
OrderBookStateMsg.h
Go to the documentation of this file.
1 /*
2 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
3 *
4 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
5 * and international copyright treaties.
6 *
7 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
8 * Services Agreement (the Agreement) and Customer end user license agreements granting
9 * a non-assignable, non-transferable and non-exclusive license to use the software
10 * for it's own data processing purposes under the terms defined in the Agreement.
11 *
12 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
13 * of this source code or associated reference material to any other location for further reproduction
14 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
15 *
16 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
17 * the terms of the Agreement is a violation of copyright law.
18 */
19 
20 #pragma once
21 
25 
26 ONIXS_SGXTITAN_ITCH_NAMESPACE_BEGIN
27 
28  /// The Order Book State Message relays information on
29  /// state changes.
30  struct ONIXS_SGXTITAN_ITCH_API OrderBookStateMsg : public IncomingMessage
31  {
32  /// Nanoseconds portion of the timestamp
33  UInt32 nanoseconds() const
34  {
35  return ordinary<UInt32>(1);
36  }
37 
38  /// The Order Book ID
40  {
41  return ordinary<UInt32>(5);
42  }
43 
44  /// Name of Order Book State
45  StrRef stateName() const
47  {
48  return fixedStr<20>(9);
49  }
50 
51  /// Total message size.
53 
54  /// Check the given size.
55  static void validateSize(MessageSize size)
56  {
57  if(size < messageSize_)
58  throwIncorrectSize("OrderBookStateMsg", size, messageSize_);
59  }
60 
61  /// Initializes instance over given memory block.
62  OrderBookStateMsg(const void* data, MessageSize size)
64  : IncomingMessage(data, size)
65  {
66  }
67  };
68 
69  /// Serializes object into string.
70  ONIXS_SGXTITAN_ITCH_API void toStr(std::string&, const OrderBookStateMsg&);
71 
72  /// Serializes object into string.
73  inline std::string toStr(const OrderBookStateMsg& msg)
74  {
75  std::string str;
76  toStr(str, msg);
77  return str;
78  }
79 
80  ///
81  inline std::ostream& operator<<(std::ostream& stream, const OrderBookStateMsg& msg)
82  {
83  stream << toStr(msg);
84  return stream;
85  }
86 
87 ONIXS_SGXTITAN_ITCH_NAMESPACE_END
#define ONIXS_SGXTITAN_ITCH_CONST_OR_CONSTEXPR
Definition: Compiler.h:46
static void validateSize(MessageSize size)
Check the given size.
UInt32 nanoseconds() const
Nanoseconds portion of the timestamp.
#define ONIXS_SGXTITAN_ITCH_NOTHROW
Definition: Compiler.h:27
UInt32 OrderBookId
Alias for Security Id type.
Definition: Defines.h:43
IncomingMessage(const void *data, MessageSize size)
UInt16 MessageSize
Aliases message length type.
Definition: Defines.h:34
OrderBookId orderBookId() const
The Order Book ID.
ONIXS_SGXTITAN_ITCH_API void toStr(std::string &, MessageType::Enum)
Appends string presentation of object.
ONIXS_SGXTITAN_ITCH_API std::ostream & operator<<(std::ostream &stream, const ServiceDescriptor &descriptor)
ONIXS_SGXTITAN_ITCH_API void throwIncorrectSize(const std::string &messageName, MessageSize receivedSize, MessageSize expectedSize)
StrRef stateName() const
Name of Order Book State.
Provides efficient way of accessing text-based FIX field values.
Definition: String.h:40
OrderBookStateMsg(const void *data, MessageSize size)
Initializes instance over given memory block.