RAMSES Documentation  27.0.130
Information for RAMSES users and developers
RamsesFrameworkConfig.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2016 BMW Car IT GmbH
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_RAMSESFRAMEWORKCONFIG_H
10 #define RAMSES_RAMSESFRAMEWORKCONFIG_H
11 
15 
16 namespace ramses
17 {
23  {
24  public:
29 
36  RamsesFrameworkConfig(int32_t argc, char const* const* argv);
37 
42 
50 
60 
73 
87 
93  void setDLTApplicationID(const char* id);
94 
100  const char* getDLTApplicationID() const;
101 
107  void setDLTApplicationDescription(const char* description);
108 
114  const char* getDLTApplicationDescription() const;
115 
126  void setPeriodicLogsEnabled(bool enabled);
127 
135 
142  void setDaemonIPForTCPCommunication(const char* ip);
143 
150  void setDaemonPortForTCPCommunication(uint16_t port);
151 
155  class RamsesFrameworkConfigImpl& impl;
156 
162 
169  };
170 
171 }
172 
173 #endif
#define RAMSES_API
Definition: APIExport.h:35
Definition: IThreadWatchdogNotification.h:37
The RamsesFrameworkConfig holds a set of parameters to be used to initialize ramses.
Definition: RamsesFrameworkConfig.h:23
void setDaemonIPForTCPCommunication(const char *ip)
Sets the IP address of the communication daemon The value is only evaluated if SOME/IP is not used....
void setDLTApplicationDescription(const char *description)
Set the application description for DLT.
RamsesFrameworkConfig(const RamsesFrameworkConfig &other)=delete
Deleted copy constructor.
status_t setRequestedRamsesShellType(ERamsesShellType requestedShellType)
Request a certain type of ramses shell.
status_t setWatchdogNotificationCallBack(IThreadWatchdogNotification *callback)
Set watchdog callback.
RamsesFrameworkConfig(int32_t argc, char const *const *argv)
Constructor of RamsesFrameworkConfig using command line parameters.
status_t disableDLTApplicationRegistration()
Disable DLT application registration.
class RamsesFrameworkConfigImpl & impl
Definition: RamsesFrameworkConfig.h:155
void setPeriodicLogsEnabled(bool enabled)
Enables or disables the periodic log messages provided by the Ramses framework.
void setDLTApplicationID(const char *id)
Set the application ID name for DLT (4 chars)
RamsesFrameworkConfig & operator=(const RamsesFrameworkConfig &other)=delete
Deleted copy assignment.
void setInterfaceSelectionIPForTCPCommunication(const char *ip)
Sets the IP address that is used to select the local network interface The value is only evaluated if...
~RamsesFrameworkConfig() override
Destructor of RamsesFrameworkConfig.
const char * getDLTApplicationID() const
Return the DLT application id value set in configuration object.
RamsesFrameworkConfig()
Default constructor of RamsesFrameworkConfig.
void setDaemonPortForTCPCommunication(uint16_t port)
Sets the port of the communication daemon The value is only evaluated if SOME/IP is not used....
status_t setWatchdogNotificationInterval(ERamsesThreadIdentifier thread, uint32_t interval)
Set watchdog notification interval of ramses threads.
const char * getDLTApplicationDescription() const
Return the DLT application description set in configuration object.
The StatusObject provides status message handling.
Definition: StatusObject.h:22
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
ERamsesThreadIdentifier
Definition: IThreadWatchdogNotification.h:20
uint32_t status_t
Status is a handle to the result of an API call.
Definition: RamsesFrameworkTypes.h:26
ERamsesShellType
Type of Ramses Shell.
Definition: RamsesFrameworkTypes.h:167