Safir SDK Core
Loading...
Searching...
No Matches
BackdoorCommand.h
Go to the documentation of this file.
1#pragma once
2
9
10#include <Safir/Dob/Message.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 Application
33{
34
35 class BackdoorCommand; //forward declaration
36 typedef std::shared_ptr<BackdoorCommand> BackdoorCommandPtr;
37 typedef std::shared_ptr<const BackdoorCommand> BackdoorCommandConstPtr;
38
42
48 {
49 public:
50 //Constructors and Create routines
54
55 //ConnectionName
63
64
65 //NodeName
73
74
75 //Command
83
84
86 static const Safir::Dob::Typesystem::TypeId ClassTypeId = -5407713379965209649LL;
87
88 //Type id for BackdoorCommand
89 Safir::Dob::Typesystem::TypeId GetTypeId() const override {return ClassTypeId;}
90
91 //Check if anything in the object has change flags set
92 bool IsChanged() override;
93
94 //Recursively set all change flags in the object
95 void SetChanged(const bool changed) override;
96
97
98 //Reflection part (Don't use unless you really know what you're doing!!)
100 const Safir::Dob::Typesystem::ArrayIndex index) override;
102 const Safir::Dob::Typesystem::ArrayIndex index) const override;
103
104 void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override;
106
107 private:
108
109#ifdef _MSC_VER
110#pragma warning (push)
111#pragma warning (disable : 4251)
112#endif
113
114 Safir::Dob::Typesystem::StringContainer m_ConnectionNameMember;
117
118#ifdef _MSC_VER
119#pragma warning (pop)
120#endif
121 };
122
123} // Application
124} // Safir
125
126
#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::GenericObjectSequenceContainer< BackdoorCommand > BackdoorCommandSequenceContainer
Definition BackdoorCommand.h:41
std::shared_ptr< BackdoorCommand > BackdoorCommandPtr
Definition BackdoorCommand.h:36
Safir::Dob::Typesystem::ObjectContainerImpl< BackdoorCommand > BackdoorCommandContainer
Definition BackdoorCommand.h:39
std::shared_ptr< const BackdoorCommand > BackdoorCommandConstPtr
Definition BackdoorCommand.h:37
Safir::Dob::Typesystem::ArrayContainer< BackdoorCommandContainer > BackdoorCommandContainerArray
Definition BackdoorCommand.h:40
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 strings (std::wstring).
Definition ValueContainers.h:127
Backdoor command messages.
Definition BackdoorCommand.h:48
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > NodeName()
static Safir::Dob::Typesystem::Int32 NodeNameMaxStringLength()
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Command()
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.
void SetChanged(const bool changed) override
Recursively set change flags in all members of this object.
static BackdoorCommandPtr Create()
static Safir::Dob::Typesystem::Int32 CommandMaxStringLength()
static Safir::Dob::Typesystem::MemberIndex NodeNameMemberIndex()
static Safir::Dob::Typesystem::Int32 ConnectionNameMaxStringLength()
static Safir::Dob::Typesystem::MemberIndex ConnectionNameMemberIndex()
void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override
Write the object to a blob.
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Command() const
String that includes the command and any parameters.
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > NodeName() const
Node name that identifies the receiving node.
BackdoorCommand(Safir::Dob::Typesystem::Int64 handle)
Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > ConnectionName()
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 CommandMemberIndex()
const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > ConnectionName() const
Dob connection name that identifies the receiving application.
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.
Safir::Dob::Typesystem::TypeId GetTypeId() const override
Get the type id of this object.
Definition BackdoorCommand.h:89
The baseclass for all messages.
Definition Message.h:46