Safir SDK Core
Loading...
Searching...
No Matches
InstanceIdPolicy.h
Go to the documentation of this file.
1#pragma once
2
8#include <Safir/Utilities/Internal/VisibilityHelpers.h>
9
10#ifdef safir_generated_Core_cpp_EXPORTS
11# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_EXPORT
12#else
13# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_IMPORT
14# define SAFIR_LIBRARY_NAME "safir_generated-Core-cpp"
15# include <Safir/Utilities/Internal/AutoLink.h>
16#endif
17#define SAFIR_GENERATED_Core_API_LOCAL SAFIR_HELPER_DLL_LOCAL
18
22namespace Safir
23{
27namespace Dob
28{
29
33
35 {
41
42
45 static Enumeration Last();
46
49
50 static std::wstring ToString(const Enumeration enumVal);
51 static Enumeration ToValue(const std::wstring & valueString);
52
53 static const Safir::Dob::Typesystem::TypeId EnumerationTypeId = 2097100482419623062LL;
54 static const Safir::Dob::Typesystem::TypeId Checksum = 1031390732314968761LL;
55
56 //Check that there is no enumeration mismatch
57 //throws an exception if there is - ConfigurationErrorException
59
61 {
62 public:
64
65 //Will throw IllegalValueException if value is not in first .. last
67 {
68 if (value < FirstOrdinal() || value > LastOrdinal())
69 {
70 throw Safir::Dob::Typesystem::IllegalValueException(L"The enumerated type Safir.Dob.InstanceIdPolicy does not have such a value",__WFILE__,__LINE__);
71 }
72 m_bIsNull = false;
73 m_bIsChanged = true;
74 m_Value = value;
75 }
76
78 {
79 if (IsNull())
80 {
81 throw Safir::Dob::Typesystem::NullException(L"Value is null",__WFILE__,__LINE__);
82 }
83 return m_Value;
84 }
85
86 //Will throw ConfigurationErrorException if there is an enumeration mismatch
87 void SetVal(const Enumeration value)
88 {
90 SetOrdinal(value);
91 }
92
93 //Will throw ConfigurationErrorException if there is an enumeration mismatch
95 {
97 return static_cast<Enumeration>(GetOrdinal());
98 }
99
100 //Will get the value if container is not null, else the supplied default value is returned.
102 {
104 return IsNull() ? defaultVal : static_cast<Enumeration>(GetOrdinal());
105 }
106
107 //compare an enumerationcontainer with a value, will return false if the container is null or the values are not equal
108 bool operator==(const Enumeration other) const
109 {CheckForMismatch(); return !IsNull() && m_Value == other;}
110
111 bool operator != (const Enumeration other) const
112 {return !(*this == other);}
113 };
114
117
118 };
120 {return second == first;}
121
123 {return !(first == second);}
124
125} // Dob
126} // Safir
127
128
#define __WFILE__
Definition Exceptions.h:31
#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
static bool operator==(const CallbackId::Enumeration first, const CallbackId::EnumerationContainer &second)
Definition CallbackId.h:139
static bool operator!=(const CallbackId::Enumeration first, const CallbackId::EnumerationContainer &second)
Definition CallbackId.h:142
DotsC_EnumerationValue EnumerationValue
The ordinal value of an enumeration.
Definition Defs.h:270
DotsC_Int32 Int32
32 bit integer type.
Definition Defs.h:66
DotsC_TypeId TypeId
A unique type identifier.
Definition Defs.h:218
STL container for arrays of DOB-containers.
Definition ArrayContainer.h:59
bool m_bIsChanged
The variable containing the change flag.
Definition ContainerBase.h:134
Base class for containers of enumeration values.
Definition EnumerationContainerBase.h:51
bool IsNull() const override
Is the container set to null?
Definition EnumerationContainerBase.h:82
bool m_bIsNull
The null flag for the enumeration container.
Definition EnumerationContainerBase.h:126
EnumerationValue m_Value
The value of the enumeration container.
Definition EnumerationContainerBase.h:132
A parameter in the call was invalid.
Definition Exceptions.h:264
Thrown when an application attempts to get the value of a member that is null.
Definition Exceptions.h:396
Container for sequences of enumeration values.
Definition SequenceContainer.h:366
Enumerates the policies concerning how instance ids are assigned by a handler.
Definition InstanceIdPolicy.h:35
static Enumeration ToValue(const std::wstring &valueString)
static std::wstring ToString(const Enumeration enumVal)
static const Safir::Dob::Typesystem::TypeId EnumerationTypeId
Definition InstanceIdPolicy.h:53
static Safir::Dob::Typesystem::EnumerationValue LastOrdinal()
static Enumeration Last()
Safir::Dob::Typesystem::EnumerationSequenceContainer< InstanceIdPolicy > EnumerationSequenceContainer
Definition InstanceIdPolicy.h:116
static Safir::Dob::Typesystem::EnumerationValue FirstOrdinal()
Safir::Dob::Typesystem::ArrayContainer< EnumerationContainer > EnumerationContainerArray
Definition InstanceIdPolicy.h:115
static void CheckForMismatch(const Safir::Dob::Typesystem::TypeId checksum=Checksum)
static const Safir::Dob::Typesystem::TypeId Checksum
Definition InstanceIdPolicy.h:54
static Enumeration First()
Enumeration
Definition InstanceIdPolicy.h:37
@ RequestorDecidesInstanceId
Definition InstanceIdPolicy.h:39
@ HandlerDecidesInstanceId
Definition InstanceIdPolicy.h:38
static Safir::Dob::Typesystem::Int32 Size()
void SetOrdinal(const Safir::Dob::Typesystem::EnumerationValue value) override
Set the ordinal value of the enumeration container.
Definition InstanceIdPolicy.h:66
Safir::Dob::Typesystem::EnumerationValue GetOrdinal() const override
Get the ordinal value of the enumeration container.
Definition InstanceIdPolicy.h:77
void SetVal(const Enumeration value)
Definition InstanceIdPolicy.h:87
bool operator==(const Enumeration other) const
Definition InstanceIdPolicy.h:108
Enumeration GetValOrDefault(const Enumeration defaultVal) const
Definition InstanceIdPolicy.h:101
Enumeration ContainedType
Definition InstanceIdPolicy.h:63
Enumeration GetVal() const
Definition InstanceIdPolicy.h:94