OnixS C++ HKEX OMD-C Handler 1.0.0
API documentation
Loading...
Searching...
No Matches
Yield.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
30namespace OnixS {
31namespace HKEX {
32namespace MarketData {
33namespace Omdc {
34
36 struct YieldMsg : public BinaryMessage
37 {
39 UInt16 msgSize() const
41 {
42 return ordinary<UInt16>(0);
43 }
44
46 UInt16 msgType() const
48 {
49 return ordinary<UInt16>(2);
50 }
51
53 UInt32 securityCode() const
55 {
56 return ordinary<UInt32>(4);
57 }
58
60 Int32 yield() const
62 {
63 return ordinary<Int32>(8);
64 }
65
68
70 static void validateSize(MessageSize size)
71 {
72 if ONIXS_HKEX_OMDC_UNLIKELY(size < messageSize_)
73 throwIncorrectSize("Yield", size, messageSize_);
74 }
75
77 YieldMsg(const void* data, MessageSize size)
79 : BinaryMessage(data, size)
80 {
81 }
82 };
83
85 ONIXS_HKEX_OMDC_API void toStr(std::string&, const YieldMsg&);
86
88 inline std::string toStr(const YieldMsg& msg)
89 {
90 std::string str;
91 toStr(str, msg);
92 return str;
93 }
94
95}
96}
97}
98}
#define ONIXS_HKEX_OMDC_CONST_OR_CONSTEXPR
Definition Compiler.h:171
#define ONIXS_HKEX_OMDC_NOTHROW
Definition Compiler.h:169
BinaryMessage() noexcept
Initializes blank instance referencing to nothing.
ONIXS_HKEX_OMDC_API void toStr(std::string &, Side::Enum)
Appends string presentation of object.
UInt16 MessageSize
Aliases message length type.
Definition Defines.h:93
ONIXS_HKEX_OMDC_API void throwIncorrectSize(const std::string &messageName, MessageSize receivedSize, MessageSize expectedSize)
YieldMsg(const void *data, MessageSize size) noexcept
Initializes instance over given memory block.
Definition Yield.h:77
UInt32 securityCode() const noexcept
Uniquely identifies a security available for trading.
Definition Yield.h:53
UInt16 msgSize() const noexcept
Size of the message.
Definition Yield.h:39
UInt16 msgType() const noexcept
Type of message.
Definition Yield.h:46
static constexpr MessageSize messageSize_
Total message size.
Definition Yield.h:67
Int32 yield() const noexcept
Current yield of the bond security based on its coupon rate and nominal price.
Definition Yield.h:60
static void validateSize(MessageSize size)
Check the given size.
Definition Yield.h:70