OnixS C++ CBOE CFE Binary Order Entry (BOE) Handler  1.11.0
API documentation
ResetRisk.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 Trading {
33 namespace BOE {
34 
35  /// Reset Risk
36  struct ONIXS_CBOE_CFE_BOE_API ResetRisk : public OutgoingMessage
37  {
38  /// Unique identifier for this Reset Risk request.
40  {
41  return riskStatusId_;
42  }
43 
44  /// Unique identifier for this Reset Risk request.
45  void riskStatusId(StrRef value)
46  {
47  riskStatusId_ = value;
48  }
49 
50  /// Single Character Values
51  StrRef riskReset() const
52  {
53  return riskReset_;
54  }
55 
56  /// Single Character Values
57  void riskReset(StrRef value)
58  {
59  riskReset_ = value;
60  }
61 
62  /// Risk will be reset for this EFID.
64  {
65  return clearingFirm_;
66  }
67 
68  /// Risk will be reset for this EFID.
69  void clearingFirm(StrRef value)
70  {
71  clearingFirm_ = value;
72  }
73 
74  /// Product name.
76  {
77  return productName_;
78  }
79 
80  /// Product name.
81  void productName(StrRef value)
82  {
83  productName_ = value;
84  }
85 
86  /// Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a list of CustomGroupIds.
88  {
89  return customGroupId_;
90  }
91 
92  /// Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a list of CustomGroupIds.
93  void customGroupId(Binary2 value)
94  {
95  customGroupId_ = value;
96  }
97 
98  /// Returns message type
99  MessageType::Enum type() const ONIXS_BATS_BOE_NOEXCEPT ONIXS_BATS_BOE_OVERRIDE { return MessageType::ResetRisk; };
100 
101  /// Validates message data
102  /// Throws std::invalid_argument exception if message content is invalid.
103  void validate() const ONIXS_BATS_BOE_OVERRIDE;
104 
105  /// Returns the text representation
106  std::string toString() const ONIXS_BATS_BOE_OVERRIDE;
107 
108  /// The text representation
109  void toString(std::string& str) const ONIXS_BATS_BOE_OVERRIDE;
110 
111  private:
112  size_t serializeTo(unsigned char*) const ONIXS_BATS_BOE_NOEXCEPT ONIXS_BATS_BOE_OVERRIDE;
113 
114  Text<16> riskStatusId_;
115  Text<8> riskReset_;
116  Alpha<4> clearingFirm_;
117  Text<6> productName_;
118  Binary2 customGroupId_;
119  };
120 
121  /// Serializes object into string.
122  ONIXS_CBOE_CFE_BOE_API void toStr(std::string&, const ResetRisk&);
123 
124  /// Serializes object into string.
125  inline std::string toStr(const ResetRisk& msg)
126  {
127  std::string str;
128  toStr(str, msg);
129  return str;
130  }
131 
132 }
133 }
134 }
135 }
void productName(StrRef value)
Product name.
Definition: ResetRisk.h:81
StrRef riskReset() const
Single Character Values.
Definition: ResetRisk.h:51
void clearingFirm(StrRef value)
Risk will be reset for this EFID.
Definition: ResetRisk.h:69
void customGroupId(Binary2 value)
Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a l...
Definition: ResetRisk.h:93
Provides efficient way of accessing text-based field values.
Definition: String.h:45
void riskStatusId(StrRef value)
Unique identifier for this Reset Risk request.
Definition: ResetRisk.h:45
void riskReset(StrRef value)
Single Character Values.
Definition: ResetRisk.h:57
void toStr(std::string &str, const FixedPointDecimal< Mantissa, Exponent > &number)
Serializes fixed-point decimal into a string.
Definition: Decimal.h:156
StrRef riskStatusId() const
Unique identifier for this Reset Risk request.
Definition: ResetRisk.h:39
Binary2 customGroupId() const
Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a l...
Definition: ResetRisk.h:87
Base class for outgoing messages.
StrRef productName() const
Product name.
Definition: ResetRisk.h:75
StrRef clearingFirm() const
Risk will be reset for this EFID.
Definition: ResetRisk.h:63
MessageType::Enum type() const ONIXS_BATS_BOE_NOEXCEPT ONIXS_BATS_BOE_OVERRIDE
Returns message type.
Definition: ResetRisk.h:99