OnixS C++ MTS Cash SDP Handler  1.6.5
API documentation
SMP.Classes.TI_DESC_CLASS_FIELD.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
4 *
5 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
6 * and international copyright treaties.
7 *
8 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
9 * Services Agreement (the Agreement) and Customer end user license agreements granting
10 * a non-assignable, non-transferable and non-exclusive license to use the software
11 * for it's own data processing purposes under the terms defined in the Agreement.
12 *
13 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
14 * of this source code or associated reference material to any other location for further reproduction
15 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
16 *
17 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
18 * the terms of the Agreement is a violation of copyright law.
19 */
20 
21 
22 /*
23 --------------
24 GENERATED FILE
25 --------------
26 */
27 
28 
29 #include <string>
30 
35 
36 
37 namespace OnixS {
38 namespace Mts {
39 namespace Cash {
40 namespace SDP {
41 
42 
43 
44 ///
45 class ONIXS_MTS_CASH_SDP_API TI_DESC_CLASS_FIELD : public Class
46 {
47 public:
49  {
50  entityName.reserve(64);
51  fieldName.reserve(64);
52  fieldType.reserve(64);
53  }
54 
55  virtual ~TI_DESC_CLASS_FIELD() {}
56 
57  /// Class id
58  virtual ClassId::Enum id() const
59  {
61  }
62 
63 
64  /// Name of the reference class
65  std::string entityName; // maxSize = 64
66 
67  /// Class_ID
69 
70  /// For a structure field, its position in the structure. For an enumerate value, its position in the enumerate.
72 
73  /// Name of the structure field (or enumerate value string)
74  std::string fieldName; // maxSize = 64
75 
76  /// Field datatype in DD formalism
77  std::string fieldType; // maxSize = 64
78 
79  /// Not significant for the client
81 
82  /// Field datatype. Significant only for a structure field.
84 
85  /// Offset of the field in data
87 
88  /// Length of field
90 
91  /// Number of elements that make up the field
93 
94  ///
95  size_t deserialize(const void* buf, size_t inLen);
96 
97  /// Provides string presentation
98  virtual std::string toString () const;
99 
100  ///
101  virtual size_t serializationBufSize() const { return 232; }
102 
103  ///
104  virtual TI_DESC_CLASS_FIELD* clone() const;
105 
106  virtual TI_DESC_CLASS_FIELD* clone(void*) const;
107 
108 private:
109  virtual size_t serialize(void* buf) const;
110 
111 };
112 
113 
114 }
115 }
116 }
117 }
std::string entityName
Name of the reference class.
std::string fieldName
Name of the structure field (or enumerate value string)
virtual ClassId::Enum id() const
Class id.
UInt32 numElems
Number of elements that make up the field.
UInt32 fieldIndx
For a structure field, its position in the structure. For an enumerate value, its position in the enu...
signed short SInt16
Definition: Defines.h:41
SInt16 derived
Not significant for the client.
std::string fieldType
Field datatype in DD formalism.
unsigned int UInt32
Definition: Defines.h:46
TI_DESC_FIELD_TYPE::Enum ptype
Field datatype. Significant only for a structure field.