OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.11.0
API documentation
SpecialField.h
Go to the documentation of this file.
1 /**
2  * \file
3  * \brief Declare `OnixS::ICE::iMpact::MarketData::SpecialField` message structure
4  */
5 /*
6  * Copyright (c) Onix Solutions Limited. All rights reserved.
7  *
8  * This software owned by Onix Solutions Limited and is protected by copyright law
9  * and international copyright treaties.
10  *
11  * Access to and use of the software is governed by the terms of the applicable ONIXS Software
12  * Services Agreement (the Agreement) and Customer end user license agreements granting
13  * a non-assignable, non-transferable and non-exclusive license to use the software
14  * for it's own data processing purposes under the terms defined in the Agreement.
15  *
16  * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
17  * of this source code or associated reference material to any other location for further reproduction
18  * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
19  *
20  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
21  * the terms of the Agreement is a violation of copyright law.
22  */
23 
24 #pragma once
25 
26 #include "../Export.h"
27 #include "../Types.h"
28 #include "../Optional.h"
29 
30 #include <iosfwd>
31 #include <string>
32 
33 namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {
34 
35 /// This class represents the Special Field Message.
36 struct ONIXS_ICEMDH_EXPORT SpecialField
37 {
38  /// Message type constant
39  enum { messageType = 'b' };
40 
41  /// This field is equivalent to Eris Futures Price. AltPriceDenominator
42  /// for the market should be applied to get the real alt price.
44 
45  /// This field is equivalent to High Eris Futures Price.
46  /// AltPriceDenominator for the market should be applied to get the real
47  /// alt price.
49 
50  /// This field is equivalent to Low Eris Futures Price.
51  /// AltPriceDenominator for the market should be applied to get the real
52  /// alt price.
54 
55  /// This field is equivalent to Volume-weighted Average Eris Futures
56  /// Price. AltPriceDenominator for the market should be applied to get the
57  /// real alt price.
59 
60  /// This field is equivalent to Last Trade Eris Futures Price.
61  /// AltPriceDenominator for the market should be applied to get the real
62  /// alt price.
64 
65  /// This field indicated if Order is AON order. This is only sent on AON
66  /// enabled market.
68 
69  /// Default constructor.
70  SpecialField();
71 
72  /// Initialize from raw message data.
73  SpecialField(const char* data, size_t dataSize);
74 
75  /// Deserialize from raw data.
76  void deserialize(const char* data, size_t dataSize);
77 
78  /// Reset all fields to default values.
79  void reset();
80 
81  /// Returns string representation.
82  std::string toString() const;
83 };
84 
85 /// Make it printable using C++ I/O streams.
86 ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const SpecialField&);
87 
88 }}}} // namespace MarketData, iMpact, ICE, OnixS
std::ostream & operator<<(std::ostream &, const Error &)
Make it printable to formatted C++ I/O streams.
This class represents the Special Field Message.
Definition: SpecialField.h:36