Safir SDK Core
Loading...
Searching...
No Matches
ResponseErrorInfo.h
Go to the documentation of this file.
1#pragma once
2
9
10#include <Safir/Dob/Item.h>
12
13#include <Safir/Utilities/Internal/VisibilityHelpers.h>
14
15#ifdef safir_generated_Core_cpp_EXPORTS
16# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_EXPORT
17#else
18# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_IMPORT
19# define SAFIR_LIBRARY_NAME "safir_generated-Core-cpp"
20# include <Safir/Utilities/Internal/AutoLink.h>
21#endif
22#define SAFIR_GENERATED_Core_API_LOCAL SAFIR_HELPER_DLL_LOCAL
23
27namespace Safir
28{
32namespace Dob
33{
34
35 class ResponseErrorInfo; //forward declaration
36 typedef std::shared_ptr<ResponseErrorInfo> ResponseErrorInfoPtr;
37 typedef std::shared_ptr<const ResponseErrorInfo> ResponseErrorInfoConstPtr;
38
42
48 {
49 public:
50 //Constructors and Create routines
54
59 const std::wstring & Code,
60 const std::wstring & Parameters);
61
62
67 const std::wstring & Code,
69 const std::wstring & Parameters);
70
71
76 const std::wstring & Code,
79 const std::wstring & Parameters);
80
81
82 //Member
89
90
91 //Index
98
99
100 //Code
108
109
110 //Parameters
118
119
121 static const Safir::Dob::Typesystem::TypeId ClassTypeId = 3197952542434689553LL;
122
123 //Type id for ResponseErrorInfo
124 Safir::Dob::Typesystem::TypeId GetTypeId() const override {return ClassTypeId;}
125
126 //Check if anything in the object has change flags set
127 bool IsChanged() override;
128
129 //Recursively set all change flags in the object
130 void SetChanged(const bool changed) override;
131
132
133 //Reflection part (Don't use unless you really know what you're doing!!)
135 const Safir::Dob::Typesystem::ArrayIndex index) override;
137 const Safir::Dob::Typesystem::ArrayIndex index) const override;
138
139 void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override;
141
142 private:
143
144#ifdef _MSC_VER
145#pragma warning (push)
146#pragma warning (disable : 4251)
147#endif
148
153
154#ifdef _MSC_VER
155#pragma warning (pop)
156#endif
157 };
158
159} // Dob
160} // Safir
161
162
#define SAFIR_GENERATED_Core_API
Definition BackdoorCommand.h:18
This namespace contains all the functionality and definitions of the SAFIR SDK.
Definition Backdoor.h:31
Safir::Dob::Typesystem::ArrayContainer< ResponseErrorInfoContainer > ResponseErrorInfoContainerArray
Definition ResponseErrorInfo.h:40
Safir::Dob::Typesystem::GenericObjectSequenceContainer< ResponseErrorInfo > ResponseErrorInfoSequenceContainer
Definition ResponseErrorInfo.h:41
std::shared_ptr< const ResponseErrorInfo > ResponseErrorInfoConstPtr
Definition ResponseErrorInfo.h:37
Safir::Dob::Typesystem::ObjectContainerImpl< ResponseErrorInfo > ResponseErrorInfoContainer
Definition ResponseErrorInfo.h:39
std::shared_ptr< ResponseErrorInfo > ResponseErrorInfoPtr
Definition ResponseErrorInfo.h:36
DotsC_Int32 Int32
32 bit integer type.
Definition Defs.h:66
DotsC_Int64 Int64
64 bit integer type.
Definition Defs.h:69
std::shared_ptr< Object > ObjectPtr
A smart pointer to an Object.
Definition Object.h:44
DotsC_ArrayIndex ArrayIndex
Index into an array.
Definition Defs.h:246
DotsC_TypeId TypeId
A unique type identifier.
Definition Defs.h:218
DotsC_MemberIndex MemberIndex
The index of a member in an object.
Definition Defs.h:237
STL container for arrays of DOB-containers.
Definition ArrayContainer.h:59
Base class for all Containers.
Definition ContainerBase.h:44
Definition ContainerProxies.h:39
Template class for all containers of automatically generated DOB objects.
Definition ObjectContainer.h:190
Container for base types.
Definition ValueContainers.h:61
Container for strings (std::wstring).
Definition ValueContainers.h:127
The baseclass for all items.
Definition Item.h:46
Contains information about one of the errors found when handling a request.
Definition ResponseErrorInfo.h:48
const Safir::Dob::Typesystem::ContainerBase & GetMember(const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const override
Get a const reference to a member container from an object.
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::Int32Container > Index()
Safir::Dob::Typesystem::TypeId GetTypeId() const override
Get the type id of this object.
Definition ResponseErrorInfo.h:124
static Safir::Dob::Typesystem::Int32 CodeMaxStringLength()
static ResponseErrorInfoPtr CreateResponseErrorInfo(const std::wstring &Code, const Safir::Dob::Typesystem::Int32 Member, const std::wstring &Parameters)
Create a ResponseErrorInfo for a specified member, with one parameter.
static Safir::Dob::Typesystem::MemberIndex ParametersMemberIndex()
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Code()
static ResponseErrorInfoPtr CreateResponseErrorInfo(const std::wstring &Code, const Safir::Dob::Typesystem::Int32 Member, const Safir::Dob::Typesystem::Int32 Index, const std::wstring &Parameters)
Create a ResponseErrorInfo for a specified member index, with one parameter.
ResponseErrorInfo(Safir::Dob::Typesystem::Int64 handle)
void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override
Write the object to a blob.
Safir::Dob::Typesystem::ObjectPtr Clone() const override
Create a copy of the object.
bool IsChanged() override
Check if any member of this object is changed.
static ResponseErrorInfoPtr Create()
void SetChanged(const bool changed) override
Recursively set change flags in all members of this object.
static Safir::Dob::Typesystem::MemberIndex MemberMemberIndex()
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Parameters()
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::Int32Container > Member()
static ResponseErrorInfoPtr CreateResponseErrorInfo(const std::wstring &Code, const std::wstring &Parameters)
Create a ResponseErrorInfo with one parameter.
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Parameters() const
Extra information when applicable.
static Safir::Dob::Typesystem::MemberIndex CodeMemberIndex()
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Code() const
The error code.
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::Int32Container > Index() const
The index of the erroneous member (when applicable).
Safir::Dob::Typesystem::ContainerBase & GetMember(const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) override
Get a reference to a member container from an object.
static Safir::Dob::Typesystem::MemberIndex IndexMemberIndex()
static Safir::Dob::Typesystem::Int32 ParametersMaxStringLength()
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::Int32Container > Member() const
The id of the erroneous member (when applicable).