MessageAck.hpp 4.18 KB
Newer Older
1
2
/**** This file has been autogenerated by gencastor from Umbrello UML model ***/

3
4
5
6
7
#ifndef CASTOR_MESSAGEACK_HPP
#define CASTOR_MESSAGEACK_HPP

// Include Files
#include "castor/IObject.hpp"
8
#include "osdep.h"
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#include <iostream>
#include <string>

namespace castor {

  // Forward declarations
  class ObjectSet;

  /**
   * class MessageAck
   * Acknowledgement message in the request handler protocol.
   */
  class MessageAck : public virtual IObject {

  public:

    /**
     * Empty Constructor
     */
    MessageAck() throw();

    /**
     * Empty Destructor
     */
    virtual ~MessageAck() throw();

    /**
     * Outputs this object in a human readable format
     * @param stream The stream where to print this object
     * @param indent The indentation to use
     * @param alreadyPrinted The set of objects already printed.
     * This is to avoid looping when printing circular dependencies
     */
    virtual void print(std::ostream& stream,
                       std::string indent,
                       castor::ObjectSet& alreadyPrinted) const;

    /**
     * Outputs this object in a human readable format
     */
    virtual void print() const;

    /**
     * Gets the type of this kind of objects
     */
    static int TYPE();

    /********************************************/
    /* Implementation of IObject abstract class */
    /********************************************/
    /**
     * Gets the type of the object
     */
    virtual int type() const;

64
65
66
67
68
    /**
     * virtual method to clone any object
     */
    virtual IObject* clone();

69
70
71
72
73
    /*********************************/
    /* End of IObject abstract class */
    /*********************************/
    /**
     * Get the value of m_status
74
     * Status of the request
75
76
77
78
79
80
81
82
     * @return the value of m_status
     */
    bool status() const {
      return m_status;
    }

    /**
     * Set the value of m_status
83
     * Status of the request
84
85
86
87
88
89
90
91
     * @param new_var the new value of m_status
     */
    void setStatus(bool new_var) {
      m_status = new_var;
    }

    /**
     * Get the value of m_errorCode
92
     * Code of the error if status shows there is one
93
94
95
96
97
98
99
100
     * @return the value of m_errorCode
     */
    int errorCode() const {
      return m_errorCode;
    }

    /**
     * Set the value of m_errorCode
101
     * Code of the error if status shows there is one
102
103
104
105
106
107
108
109
     * @param new_var the new value of m_errorCode
     */
    void setErrorCode(int new_var) {
      m_errorCode = new_var;
    }

    /**
     * Get the value of m_errorMessage
110
     * Error message if status shows there is an error
111
112
113
114
115
116
117
118
     * @return the value of m_errorMessage
     */
    std::string errorMessage() const {
      return m_errorMessage;
    }

    /**
     * Set the value of m_errorMessage
119
     * Error message if status shows there is an error
120
121
122
123
124
125
     * @param new_var the new value of m_errorMessage
     */
    void setErrorMessage(std::string new_var) {
      m_errorMessage = new_var;
    }

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    /**
     * Get the value of m_requestId
     * Cuuid associated to the request in case there was no error
     * @return the value of m_requestId
     */
    std::string requestId() const {
      return m_requestId;
    }

    /**
     * Set the value of m_requestId
     * Cuuid associated to the request in case there was no error
     * @param new_var the new value of m_requestId
     */
    void setRequestId(std::string new_var) {
      m_requestId = new_var;
    }

144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    /**
     * Get the value of m_id
     * The id of this object
     * @return the value of m_id
     */
    u_signed64 id() const {
      return m_id;
    }

    /**
     * Set the value of m_id
     * The id of this object
     * @param new_var the new value of m_id
     */
    void setId(u_signed64 new_var) {
      m_id = new_var;
    }
161
162
163

  private:

164
    /// Status of the request
165
166
    bool m_status;

167
    /// Code of the error if status shows there is one
168
169
    int m_errorCode;

170
    /// Error message if status shows there is an error
171
172
    std::string m_errorMessage;

173
174
175
    /// Cuuid associated to the request in case there was no error
    std::string m_requestId;

176
    /// The id of this object
177
    u_signed64 m_id;
178
179
180
181
182
183

  }; // end of class MessageAck

}; // end of namespace castor

#endif // CASTOR_MESSAGEACK_HPP