Safir SDK Core
Loading...
Searching...
No Matches
Parameters.h
Go to the documentation of this file.
1#pragma once
2
9
11
12#include <Safir/Utilities/Internal/VisibilityHelpers.h>
13
14#ifdef safir_generated_Core_cpp_EXPORTS
15# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_EXPORT
16#else
17# define SAFIR_GENERATED_Core_API SAFIR_HELPER_DLL_IMPORT
18# define SAFIR_LIBRARY_NAME "safir_generated-Core-cpp"
19# include <Safir/Utilities/Internal/AutoLink.h>
20#endif
21#define SAFIR_GENERATED_Core_API_LOCAL SAFIR_HELPER_DLL_LOCAL
22
26namespace Safir
27{
31namespace Control
32{
33
34 class Parameters; //forward declaration
35 typedef std::shared_ptr<Parameters> ParametersPtr;
36 typedef std::shared_ptr<const Parameters> ParametersConstPtr;
37
41
47 {
48 public:
49 //Constructors and Create routines
53
54 //ShutdownCommand
58 static std::wstring ShutdownCommand();
59
60 //RebootCommand
64 static std::wstring RebootCommand();
65
67 static const Safir::Dob::Typesystem::TypeId ClassTypeId = 9182649462744086596LL;
68
69 //Type id for Parameters
70 Safir::Dob::Typesystem::TypeId GetTypeId() const override {return ClassTypeId;}
71
72 //Check if anything in the object has change flags set
73 bool IsChanged() override;
74
75 //Recursively set all change flags in the object
76 void SetChanged(const bool changed) override;
77
78
79 //Reflection part (Don't use unless you really know what you're doing!!)
81 const Safir::Dob::Typesystem::ArrayIndex index) override;
83 const Safir::Dob::Typesystem::ArrayIndex index) const override;
84
85 void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override;
87
88 private:
89
90#ifdef _MSC_VER
91#pragma warning (push)
92#pragma warning (disable : 4251)
93#endif
94
95
96#ifdef _MSC_VER
97#pragma warning (pop)
98#endif
99 };
100
101} // Control
102} // Safir
103
104
#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
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
std::shared_ptr< Parameters > ParametersPtr
Definition Parameters.h:35
std::shared_ptr< const Parameters > ParametersConstPtr
Definition Parameters.h:36
Safir::Dob::Typesystem::GenericObjectSequenceContainer< Parameters > ParametersSequenceContainer
Definition Parameters.h:40
Safir::Dob::Typesystem::ObjectContainerImpl< Parameters > ParametersContainer
Definition Parameters.h:38
Safir::Dob::Typesystem::ArrayContainer< ParametersContainer > ParametersContainerArray
Definition Parameters.h:39
STL container for arrays of DOB-containers.
Definition ArrayContainer.h:59
Base class for all Containers.
Definition ContainerBase.h:44
Template class for all containers of automatically generated DOB objects.
Definition ObjectContainer.h:190
This class has no summary.
Definition Parameters.h:47
Safir::Dob::Typesystem::ObjectPtr Clone() const override
Create a copy of the object.
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.
void SetChanged(const bool changed) override
Recursively set change flags in all members of this object.
bool IsChanged() override
Check if any member of this object is changed.
static ParametersPtr Create()
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.
static std::wstring ShutdownCommand()
Command to be executed for a computer shutdown initiated by Safir.
Parameters(Safir::Dob::Typesystem::Int64 handle)
static std::wstring RebootCommand()
Command to be executed for a computer reboot initiated by Safir.
Safir::Dob::Typesystem::TypeId GetTypeId() const override
Get the type id of this object.
Definition Parameters.h:70
void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override
Write the object to a blob.
This class is intended to be used as baseclass for classes that only contains parameters.
Definition Parametrization.h:46