OnixS C++ CME MDP Conflated TCP Handler  1.1.0
API Documentation
Composites.h
Go to the documentation of this file.
1 // Copyright Onix Solutions Limited [OnixS]. All rights reserved.
2 //
3 // This software owned by Onix Solutions Limited [OnixS] and is
4 // protected by copyright law and international copyright treaties.
5 //
6 // Access to and use of the software is governed by the terms of the applicable
7 // OnixS Software Services Agreement (the Agreement) and Customer end user license
8 // agreements granting a non-assignable, non-transferable and non-exclusive license
9 // to use the software for it's own data processing purposes under the terms defined
10 // in the Agreement.
11 //
12 // Except as otherwise granted within the terms of the Agreement, copying or
13 // reproduction of any part of this source code or associated reference material
14 // to any other location for further reproduction or redistribution, and any
15 // amendments to this copyright notice, are expressly prohibited.
16 //
17 // Any reproduction or redistribution for sale or hiring of the Software not in
18 // accordance with the terms of the Agreement is a violation of copyright law.
19 //
20 
21 #pragma once
22 
24 
27 
29 ONIXS_CONFLATEDTCP_DATA_PACKING_BEGIN(1)
30 
31 /// Repeating group dimensions.
32 ///
33 /// FIX type: NumInGroup.
35 {
36 public:
37  /// Size of the composite.
38  enum { Size = 3 };
39 
40  /// Type alias for the `BlockLength`.
42 
43  /// Type alias for the `NumInGroup`.
44  typedef UInt8 NumInGroup;
45 
46  /// \return the `blockLength` field.
48  BlockLength blockLength() const
50  {
51  return blockLength_;
52  }
53 
54  /// Sets the `blockLength` field.
55  void setBlockLength(BlockLength value)
57  {
58  blockLength_ = value;
59  }
60 
61  /// \return the `numInGroup` field.
63  NumInGroup numInGroup() const
65  {
66  return numInGroup_;
67  }
68 
69  /// Sets the `numInGroup` field.
70  void setNumInGroup(NumInGroup value)
72  {
73  numInGroup_ = value;
74  }
75 
76 private:
77  BlockLength blockLength_;
78  NumInGroup numInGroup_;
79 };
80 
81 
82 /// Repeating group dimensions.
84 {
85 public:
86  /// Size of the composite.
87  enum { Size = 4 };
88 
89  /// Type alias for the `BlockLength`.
90  ///
91  /// FIX type: Length.
93 
94  /// Type alias for the `NumInGroup`.
95  ///
96  /// FIX type: NumInGroup.
97  typedef UInt16 NumInGroup;
98 
99  /// \return the `blockLength` field.
100  ///
101  /// FIX type: Length.
103  BlockLength blockLength() const
105  {
106  return blockLength_;
107  }
108 
109  /// Sets the `blockLength` field.
110  ///
111  /// FIX type: Length.
112  void setBlockLength(BlockLength value)
114  {
115  blockLength_ = value;
116  }
117 
118  /// \return the `numInGroup` field.
119  ///
120  /// FIX type: NumInGroup.
122  NumInGroup numInGroup() const
124  {
125  return numInGroup_;
126  }
127 
128  /// Sets the `numInGroup` field.
129  ///
130  /// FIX type: NumInGroup.
131  void setNumInGroup(NumInGroup value)
133  {
134  numInGroup_ = value;
135  }
136 
137 private:
138  BlockLength blockLength_;
139  NumInGroup numInGroup_;
140 };
141 
142 
143 /// Template ID and length of message root.
145 {
146 public:
147  /// Size of the composite.
148  enum { Size = 8 };
149 
150  /// Type alias for the `BlockLength`.
152 
153  /// Type alias for the `TemplateId`.
155 
156  /// Type alias for the `SchemaId`.
157  typedef UInt16 SchemaId;
158 
159  /// Type alias for the `Version`.
160  typedef UInt16 Version;
161 
162  /// \return the `blockLength` field.
164  BlockLength blockLength() const
166  {
167  return blockLength_;
168  }
169 
170  /// Sets the `blockLength` field.
171  void setBlockLength(BlockLength value)
173  {
174  blockLength_ = value;
175  }
176 
177  /// \return the `templateId` field.
179  TemplateId templateId() const
181  {
182  return templateId_;
183  }
184 
185  /// Sets the `templateId` field.
186  void setTemplateId(TemplateId value)
188  {
189  templateId_ = value;
190  }
191 
192  /// \return the `schemaId` field.
194  SchemaId schemaId() const
196  {
197  return schemaId_;
198  }
199 
200  /// Sets the `schemaId` field.
201  void setSchemaId(SchemaId value)
203  {
204  schemaId_ = value;
205  }
206 
207  /// \return the `version` field.
209  Version version() const
211  {
212  return version_;
213  }
214 
215  /// Sets the `version` field.
216  void setVersion(Version value)
218  {
219  version_ = value;
220  }
221 
222 private:
223  BlockLength blockLength_;
224  TemplateId templateId_;
225  SchemaId schemaId_;
226  Version version_;
227 };
228 
229 
231 
232 ONIXS_CONFLATEDTCP_DATA_PACKING_END
233 
234 
235 
#define ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_END
Definition: ABI.h:144
NumInGroup numInGroup() const noexcept
Definition: Composites.h:63
#define ONIXS_CONFLATEDTCP_NOTHROW
Definition: Compiler.h:193
Template ID and length of message root.
Definition: Composites.h:144
UInt16 SchemaId
Type alias for the SchemaId.
Definition: Composites.h:157
UInt16 BlockLength
Type alias for the BlockLength.
Definition: Composites.h:92
UInt16 Version
Type alias for the Version.
Definition: Composites.h:160
BlockLength blockLength() const noexcept
Definition: Composites.h:48
void setTemplateId(TemplateId value) noexcept
Sets the templateId field.
Definition: Composites.h:186
#define ONIXS_CONFLATEDTCP_NODISCARD
Definition: Compiler.h:202
void setNumInGroup(NumInGroup value) noexcept
Sets the numInGroup field.
Definition: Composites.h:131
void setBlockLength(BlockLength value) noexcept
Sets the blockLength field.
Definition: Composites.h:55
UInt16 BlockLength
Type alias for the BlockLength.
Definition: Composites.h:41
void setBlockLength(BlockLength value) noexcept
Sets the blockLength field.
Definition: Composites.h:112
void setNumInGroup(NumInGroup value) noexcept
Sets the numInGroup field.
Definition: Composites.h:70
#define ONIXS_CONFLATEDTCP_LTWT_CLASS
Definition: ABI.h:84
#define ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_BEGIN
Definition: ABI.h:140
void setBlockLength(BlockLength value) noexcept
Sets the blockLength field.
Definition: Composites.h:171
UInt16 NumInGroup
Type alias for the NumInGroup.
Definition: Composites.h:97
UInt8 NumInGroup
Type alias for the NumInGroup.
Definition: Composites.h:44
void setSchemaId(SchemaId value) noexcept
Sets the schemaId field.
Definition: Composites.h:201
UInt16 TemplateId
Type alias for the TemplateId.
Definition: Composites.h:154
void setVersion(Version value) noexcept
Sets the version field.
Definition: Composites.h:216
UInt16 BlockLength
Type alias for the BlockLength.
Definition: Composites.h:151