Safir SDK Core
Loading...
Searching...
No Matches
Parameters.h
Go to the documentation of this file.
1#pragma once
2
9
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 Websocket
33{
34
35 class Parameters; //forward declaration
36 typedef std::shared_ptr<Parameters> ParametersPtr;
37 typedef std::shared_ptr<const Parameters> ParametersConstPtr;
38
42
48 {
49 public:
50 //Constructors and Create routines
54
55 //ServerEndpoint
62 static std::wstring ServerEndpoint();
63
64 //PingInterval
72
73 //EnableTypesystemCommands
78
80 static const Safir::Dob::Typesystem::TypeId ClassTypeId = 9112010565285018424LL;
81
82 //Type id for Parameters
83 Safir::Dob::Typesystem::TypeId GetTypeId() const override {return ClassTypeId;}
84
85 //Check if anything in the object has change flags set
86 bool IsChanged() override;
87
88 //Recursively set all change flags in the object
89 void SetChanged(const bool changed) override;
90
91
92 //Reflection part (Don't use unless you really know what you're doing!!)
94 const Safir::Dob::Typesystem::ArrayIndex index) override;
96 const Safir::Dob::Typesystem::ArrayIndex index) const override;
97
98 void WriteToBlob(Safir::Dob::Typesystem::Int64 handle) const override;
100
101 private:
102
103#ifdef _MSC_VER
104#pragma warning (push)
105#pragma warning (disable : 4251)
106#endif
107
108
109#ifdef _MSC_VER
110#pragma warning (pop)
111#endif
112 };
113
114} // Websocket
115} // Safir
116
117
#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
Float32 Second
32 bit representation of Second.
Definition Defs.h:130
Safir::Dob::Typesystem::GenericObjectSequenceContainer< Parameters > ParametersSequenceContainer
Definition Parameters.h:41
Safir::Dob::Typesystem::ArrayContainer< ParametersContainer > ParametersContainerArray
Definition Parameters.h:40
std::shared_ptr< const Parameters > ParametersConstPtr
Definition Parameters.h:37
Safir::Dob::Typesystem::ObjectContainerImpl< Parameters > ParametersContainer
Definition Parameters.h:39
std::shared_ptr< Parameters > ParametersPtr
Definition Parameters.h:36
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 is intended to be used as baseclass for classes that only contains parameters.
Definition Parametrization.h:46
Sent from web api to client.
Definition Parameters.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.
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.
static Safir::Dob::Typesystem::Si32::Second PingInterval()
Interval at which messges with the ping opcode is sent to clients to keep connection open.
bool IsChanged() override
Check if any member of this object is changed.
static bool EnableTypesystemCommands()
Should typesystem commands be handled, If False typesystem commands are invalid.
Parameters(Safir::Dob::Typesystem::Int64 handle)
void SetChanged(const bool changed) override
Recursively set change flags in all members of this 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.
static std::wstring ServerEndpoint()
The ip address and port for the websocket server on the format ip_address:port For example if running...
Safir::Dob::Typesystem::TypeId GetTypeId() const override
Get the type id of this object.
Definition Parameters.h:83
static ParametersPtr Create()