OnixS C++ Cboe CFE Multicast PITCH Market Data Handler  1.12.1
API documentation
TimeReference.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 
22 #include <vector>
23 
28 
29 
30 namespace OnixS {
31 namespace CboeCFE {
32 namespace MarketData {
33 namespace Pitch {
34 
35  /// The Time Reference message is used to provide a midnight reference point for recipients of the feed.
37  {
38  /// Midnight Central Time reference time for subsequent Time messages, expressed as number of whole
39  /// seconds since the Epoch (Midnight January 1, 1970 UTC).
42  {
43  return ordinary<Binary4>(2);
44  }
45 
46  /// Number of whole seconds from midnight Central Time.
47  Binary4 time() const
49  {
50  return ordinary<Binary4>(6);
51  }
52 
53  /// Nanosecond offset from last unit timestamp.
56  {
57  return ordinary<Binary4>(10);
58  }
59 
60  /// Current Trade Date
63  {
64  return ordinary<BinaryDate>(14);
65  }
66 
67  /// Total message size.
69 
70  /// Check the given size.
71  static void validateSize(MessageSize size)
72  {
73  if (ONIXS_BATS_PITCH_CHECK_EXPECT((size < messageSize_), false))
74  throwIncorrectSize("TimeReference", size, messageSize_);
75  }
76 
77  /// Initializes instance over given memory block.
78  TimeReferenceMsg(const void* data, MessageSize size)
80  : BinaryMessage(data, size)
81  {
82  }
83  };
84 
85  /// Serializes object into string.
86  ONIXS_CBOECFE_PITCH_API void toStr(std::string&, const TimeReferenceMsg&);
87 
88  /// Serializes object into string.
89  inline std::string toStr(const TimeReferenceMsg& msg)
90  {
91  std::string str;
92  toStr(str, msg);
93  return str;
94  }
95 
96 }
97 }
98 }
99 }
Binary4 time() const ONIXS_BATS_PITCH_NOTHROW
Number of whole seconds from midnight Central Time.
Definition: TimeReference.h:47
ONIXS_CBOECFE_PITCH_API ONIXS_BATS_PITCH_COLDPATH ONIXS_BATS_PITCH_NORETURN void throwIncorrectSize(const std::string &messageName, MessageSize receivedSize, MessageSize expectedSize)
#define ONIXS_BATS_PITCH_CONST_OR_CONSTEXPR
Definition: Compiler.h:110
TimeReferenceMsg(const void *data, MessageSize size) ONIXS_BATS_PITCH_NOTHROW
Initializes instance over given memory block.
Definition: TimeReference.h:78
Binary4 midnightReference() const ONIXS_BATS_PITCH_NOTHROW
Definition: TimeReference.h:40
Encapsulates services for manipulating little endian encoded messages.
BinaryMessage() ONIXS_BATS_PITCH_NOTHROW
Initializes blank instance referencing to nothing.
Binary2 MessageSize
Aliases message length type.
Definition: Defines.h:90
static ONIXS_BATS_PITCH_CONST_OR_CONSTEXPR MessageSize messageSize_
Total message size.
Definition: TimeReference.h:68
Binary4 timeOffset() const ONIXS_BATS_PITCH_NOTHROW
Nanosecond offset from last unit timestamp.
Definition: TimeReference.h:54
The Time Reference message is used to provide a midnight reference point for recipients of the feed...
Definition: TimeReference.h:36
#define ONIXS_BATS_PITCH_NOTHROW
Definition: Compiler.h:107
ONIXS_CBOECFE_PITCH_API void toStr(std::string &, SideIndicator::Enum)
Appends string presentation of object.
BinaryDate tradeDate() const ONIXS_BATS_PITCH_NOTHROW
Current Trade Date.
Definition: TimeReference.h:61
static void validateSize(MessageSize size)
Check the given size.
Definition: TimeReference.h:71