From 3fb3d5326f0a026ee6b87351c02f79b073b3594c Mon Sep 17 00:00:00 2001 From: tftzee <49162693+rex-schilasky@users.noreply.github.com> Date: Wed, 13 Mar 2024 18:03:09 +0100 Subject: [PATCH 1/3] deprecation.rst fixed --- doc/rst/versions/5.13/deprecation.rst | 32 +++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/doc/rst/versions/5.13/deprecation.rst b/doc/rst/versions/5.13/deprecation.rst index 648e7e115a..e0a040c4ca 100644 --- a/doc/rst/versions/5.13/deprecation.rst +++ b/doc/rst/versions/5.13/deprecation.rst @@ -95,6 +95,8 @@ Deprecated API - :file:`cimpl/ecal_monitoring_cimpl.h`: + .. code-block:: cpp + int eCAL_Monitoring_PubMonitoring(int state_, const char* name_); int eCAL_Monitoring_PubLogging(int state_, const char* name_); @@ -105,6 +107,7 @@ Deprecated API int eCAL_Process_GetHostID(); float eCAL_Process_GetProcessCpuUsage(); unsigned long eCAL_Process_GetProcessMemory(); + long long eCAL_Process_GetSClock(); long long eCAL_Process_GetSBytes(); long long eCAL_Process_GetWClock(); @@ -118,6 +121,7 @@ Deprecated API int eCAL_Pub_SetQOS(ECAL_HANDLE handle_, struct SWriterQOSC qos_); int eCAL_Pub_GetQOS(ECAL_HANDLE handle_, struct SWriterQOSC* qos_); + int eCAL_Pub_SetMaxBandwidthUDP(ECAL_HANDLE handle_, long bandwidth_); - :file:`cimpl/ecal_server_cimpl.h`: @@ -133,6 +137,7 @@ Deprecated API int eCAL_Sub_SetQOS(ECAL_HANDLE handle_, struct SReaderQOSC qos_); int eCAL_Sub_GetQOS(ECAL_HANDLE handle_, struct SReaderQOSC* qos_); + int eCAL_Sub_SetTimeout(ECAL_HANDLE handle_, int timeout_); - :file:`cimpl/ecal_tlayer_cimpl.h`: @@ -158,6 +163,8 @@ Deprecated API - :file:`ecal_callback.h`: + .. code-block:: cpp + struct SPubEventCallbackData { eCAL_Publisher_Event type; @@ -206,6 +213,7 @@ Deprecated API int GetHostID(); float GetProcessCpuUsage(); unsigned long GetProcessMemory(); + long long GetWClock(); long long GetWBytes(); long long GetRClock(); @@ -217,11 +225,15 @@ Deprecated API CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool SetTypeName(const std::string& topic_type_name_); bool SetDescription(const std::string& topic_desc_); + bool SetQOS(const QOS::SWriterQOS& qos_); QOS::SWriterQOS GetQOS(); + bool SetMaxBandwidthUDP(long bandwidth_); + std::string GetTypeName() const; std::string GetDescription() const; @@ -231,10 +243,13 @@ Deprecated API CSubscriber(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool SetQOS(const QOS::SReaderQOS& qos_); QOS::SReaderQOS GetQOS(); + std::string GetTypeName() const; std::string GetDescription() const; + bool SetTimeout(int timeout_); - :file:`ecal_tlayer.h`: @@ -268,40 +283,57 @@ Deprecated API - :file:`ecal_util.h`: + .. code-block:: cpp + bool GetTopicTypeName(const std::string& topic_name_, std::string& topic_type_); std::string GetTopicTypeName(const std::string& topic_name_); + bool GetTopicDescription(const std::string& topic_name_, std::string& topic_desc_); std::string GetTopicDescription(const std::string& topic_name_); std::string GetDescription(const std::string& topic_name_); - :file:`msg/capnproto/dynamic.h`: + .. code-block:: cpp + std::string GetTypeName() const; - :file:`msg/capnproto/subscriber.h`: + .. code-block:: cpp + std::string GetTypeName() const; - :file:`msg/protobuf/publisher.h`: + .. code-block:: cpp + std::string GetTypeName() const; std::string GetDescription() const; - :file:`msg/string/publisher.h`: + .. code-block:: cpp + CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_); - :file:`msg/publisher.h`: + .. code-block:: cpp + CMsgPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); + virtual std::string GetTypeName() const; virtual std::string GetDescription() const; - :file:`msg/subscriber.h`: + .. code-block:: cpp + CMsgSubscriber(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = "") + virtual std::string GetTypeName() const; virtual std::string GetDescription() const; From db65e916b0781d818b22a4e521f5351b6b1302e0 Mon Sep 17 00:00:00 2001 From: rex-schilasky <49162693+rex-schilasky@users.noreply.github.com> Date: Thu, 14 Mar 2024 10:29:40 +0100 Subject: [PATCH 2/3] blanks and indentations fixed --- doc/rst/versions/5.13/deprecation.rst | 487 +++++++++++++------------- 1 file changed, 240 insertions(+), 247 deletions(-) diff --git a/doc/rst/versions/5.13/deprecation.rst b/doc/rst/versions/5.13/deprecation.rst index e0a040c4ca..82e0f61a26 100644 --- a/doc/rst/versions/5.13/deprecation.rst +++ b/doc/rst/versions/5.13/deprecation.rst @@ -25,331 +25,324 @@ Deprecated API ============== - :file:`cimpl/ecal_callback_cimpl.h`: - + .. code-block:: cpp - - enum eCAL_Subscriber_Event - { - sub_event_none = 0, - sub_event_connected = 1, - sub_event_disconnected = 2, - sub_event_dropped = 3, - sub_event_timeout = 4, //!< deprecated, will be removed in future eCAL versions - sub_event_corrupted = 5, - sub_event_update_connection = 6, - }; - - struct SPubEventCallbackDataC - { - enum eCAL_Publisher_Event type; - long long time; - long long clock; - const char* tid; - const char* tname; - const char* tencoding; - const char* tdesc; - - const char* ttype; //!< deprecated, please use new tname + tencoding fields - }; - - struct SSubEventCallbackDataC - { - enum eCAL_Subscriber_Event type; - long long time; - long long clock; - const char* tid; - const char* tname; - const char* tencoding; - const char* tdesc; - - const char* ttype; //!< deprecated, please use new tname + tencoding fields - }; - + + enum eCAL_Subscriber_Event + { + sub_event_none = 0, + sub_event_connected = 1, + sub_event_disconnected = 2, + sub_event_dropped = 3, + sub_event_timeout = 4, //!< deprecated, will be removed in future eCAL versions + sub_event_corrupted = 5, + sub_event_update_connection = 6, + }; + + struct SPubEventCallbackDataC + { + enum eCAL_Publisher_Event type; + long long time; + long long clock; + const char* tid; + const char* tname; + const char* tencoding; + const char* tdesc; + + const char* ttype; //!< deprecated, please use new tname + tencoding fields + }; + + struct SSubEventCallbackDataC + { + enum eCAL_Subscriber_Event type; + long long time; + long long clock; + const char* tid; + const char* tname; + const char* tencoding; + const char* tdesc; + + const char* ttype; //!< deprecated, please use new tname + tencoding fields + }; + - :file:`cimpl/ecal_client_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Client_AddResponseCallbackC(ECAL_HANDLE handle_, ResponseCallbackCT callback_, void* par_); - + + int eCAL_Client_AddResponseCallbackC(ECAL_HANDLE handle_, ResponseCallbackCT callback_, void* par_); + - :file:`cimpl/ecal_init_cimpl.h`: - + .. code-block:: cpp - - #define eCAL_Init_Publisher 0x01 - #define eCAL_Init_Subscriber 0x02 - #define eCAL_Init_Service 0x04 - #define eCAL_Init_Monitoring 0x08 - #define eCAL_Init_Logging 0x10 - #define eCAL_Init_TimeSync 0x20 - #define eCAL_Init_RPC 0x40 /*!< deprecated, will be removed in future eCAL versions */ - #define eCAL_Init_ProcessReg 0x80 - + + #define eCAL_Init_Publisher 0x01 + #define eCAL_Init_Subscriber 0x02 + #define eCAL_Init_Service 0x04 + #define eCAL_Init_Monitoring 0x08 + #define eCAL_Init_Logging 0x10 + #define eCAL_Init_TimeSync 0x20 + #define eCAL_Init_RPC 0x40 /*!< deprecated, will be removed in future eCAL versions */ + #define eCAL_Init_ProcessReg 0x80 + - :file:`cimpl/ecal_log_cimpl.h`: - + .. code-block:: cpp - - void eCAL_Logging_StartCoreTimer(); - void eCAL_Logging_StopCoreTimer(); - void eCAL_Logging_SetCoreTime(double time_); - double eCAL_Logging_GetCoreTime(); - + + void eCAL_Logging_StartCoreTimer(); + void eCAL_Logging_StopCoreTimer(); + void eCAL_Logging_SetCoreTime(double time_); + double eCAL_Logging_GetCoreTime(); + - :file:`cimpl/ecal_monitoring_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Monitoring_PubMonitoring(int state_, const char* name_); - int eCAL_Monitoring_PubLogging(int state_, const char* name_); - + + int eCAL_Monitoring_PubMonitoring(int state_, const char* name_); + int eCAL_Monitoring_PubLogging(int state_, const char* name_); + - :file:`cimpl/ecal_process_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Process_GetHostID(); - float eCAL_Process_GetProcessCpuUsage(); - unsigned long eCAL_Process_GetProcessMemory(); - - long long eCAL_Process_GetSClock(); - long long eCAL_Process_GetSBytes(); - long long eCAL_Process_GetWClock(); - long long eCAL_Process_GetWBytes(); - long long eCAL_Process_GetRClock(); - long long eCAL_Process_GetRBytes(); - + + int eCAL_Process_GetHostID(); + float eCAL_Process_GetProcessCpuUsage(); + unsigned long eCAL_Process_GetProcessMemory(); + + long long eCAL_Process_GetSClock(); + long long eCAL_Process_GetSBytes(); + long long eCAL_Process_GetWClock(); + long long eCAL_Process_GetWBytes(); + long long eCAL_Process_GetRClock(); + long long eCAL_Process_GetRBytes(); + - :file:`cimpl/ecal_publisher_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Pub_SetQOS(ECAL_HANDLE handle_, struct SWriterQOSC qos_); - int eCAL_Pub_GetQOS(ECAL_HANDLE handle_, struct SWriterQOSC* qos_); + + int eCAL_Pub_SetQOS(ECAL_HANDLE handle_, struct SWriterQOSC qos_); + int eCAL_Pub_GetQOS(ECAL_HANDLE handle_, struct SWriterQOSC* qos_); + + int eCAL_Pub_SetMaxBandwidthUDP(ECAL_HANDLE handle_, long bandwidth_); - int eCAL_Pub_SetMaxBandwidthUDP(ECAL_HANDLE handle_, long bandwidth_); - - :file:`cimpl/ecal_server_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Server_AddMethodCallbackC(ECAL_HANDLE handle_, const char* method_, const char* req_type_, const char* resp_type_, MethodCallbackCT callback_, void* par_); - int eCAL_Server_RemMethodCallbackC(ECAL_HANDLE handle_, const char* method_); - + + int eCAL_Server_AddMethodCallbackC(ECAL_HANDLE handle_, const char* method_, const char* req_type_, const char* resp_type_, MethodCallbackCT callback_, void* par_); + int eCAL_Server_RemMethodCallbackC(ECAL_HANDLE handle_, const char* method_); + - :file:`cimpl/ecal_subscriber_cimpl.h`: - + .. code-block:: cpp - - int eCAL_Sub_SetQOS(ECAL_HANDLE handle_, struct SReaderQOSC qos_); - int eCAL_Sub_GetQOS(ECAL_HANDLE handle_, struct SReaderQOSC* qos_); + + int eCAL_Sub_SetQOS(ECAL_HANDLE handle_, struct SReaderQOSC qos_); + int eCAL_Sub_GetQOS(ECAL_HANDLE handle_, struct SReaderQOSC* qos_); + + int eCAL_Sub_SetTimeout(ECAL_HANDLE handle_, int timeout_); - int eCAL_Sub_SetTimeout(ECAL_HANDLE handle_, int timeout_); - - :file:`cimpl/ecal_tlayer_cimpl.h`: - + .. code-block:: cpp - enum eTransportLayerC - { - tlayer_none = 0, - tlayer_udp_mc = 1, - tlayer_shm = 4, - tlayer_tcp = 5, - tlayer_inproc = 42, /*!< deprecated, whole layer will be removed in future eCAL versions */ - tlayer_all = 255 - }; - + enum eTransportLayerC + { + tlayer_none = 0, + tlayer_udp_mc = 1, + tlayer_shm = 4, + tlayer_tcp = 5, + tlayer_inproc = 42, /*!< deprecated, whole layer will be removed in future eCAL versions */ + tlayer_all = 255 + }; + - :file:`cimpl/ecal_util_cimpl.h`: .. code-block:: cpp - - int eCAL_Util_GetTypeName(const char* topic_name_, void* topic_type_, int topic_type_len_); - int eCAL_Util_GetDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); - + + int eCAL_Util_GetTypeName(const char* topic_name_, void* topic_type_, int topic_type_len_); + int eCAL_Util_GetDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); + - :file:`ecal_callback.h`: - + .. code-block:: cpp - + struct SPubEventCallbackData - { - eCAL_Publisher_Event type; - long long time; - long long clock; - std::string tid; - std::string ttype; //!< deprecated, please use new tdatatype field - std::string tdesc; //!< deprecated, please use new tdatatype field - - SDataTypeInformation tdatatype; - }; - + { + eCAL_Publisher_Event type; + long long time; + long long clock; + std::string tid; + std::string ttype; //!< deprecated, please use new tdatatype field + std::string tdesc; //!< deprecated, please use new tdatatype field + + SDataTypeInformation tdatatype; + }; + struct SSubEventCallbackData - { - eCAL_Subscriber_Event type; - long long time; - long long clock; - std::string tid; - std::string ttype; //!< deprecated, please use new tdatatype field - std::string tdesc; //!< deprecated, please use new tdatatype field - - SDataTypeInformation tdatatype; - }; - + { + eCAL_Subscriber_Event type; + long long time; + long long clock; + std::string tid; + std::string ttype; //!< deprecated, please use new tdatatype field + std::string tdesc; //!< deprecated, please use new tdatatype field + + SDataTypeInformation tdatatype; + }; + - :file:`ecal_log.h`: - + .. code-block:: cpp - - void StartCoreTimer(); - void StopCoreTimer(); - void SetCoreTime(double time_); - double GetCoreTime(); - + + void StartCoreTimer(); + void StopCoreTimer(); + void SetCoreTime(double time_); + double GetCoreTime(); + - :file:`ecal_monitoring.h`: - - .. code-block:: cpp - - int GetMonitoring(std::string& mon_); - int PubMonitoring(bool state_, std::string name_ = "ecal.monitoring"); - int PubLogging(bool state_, std::string name_ = "ecal.logging"); - -- :file:`ecal_process.h`: - - .. code-block:: cpp - - int GetHostID(); - float GetProcessCpuUsage(); - unsigned long GetProcessMemory(); - - long long GetWClock(); - long long GetWBytes(); - long long GetRClock(); - long long GetRBytes(); - -- :file:`ecal_publisher.h`: - + .. code-block:: cpp - - CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + int GetMonitoring(std::string& mon_); + int PubMonitoring(bool state_, std::string name_ = "ecal.monitoring"); + int PubLogging(bool state_, std::string name_ = "ecal.logging"); - bool SetTypeName(const std::string& topic_type_name_); - bool SetDescription(const std::string& topic_desc_); +- :file:`ecal_process.h`: - bool SetQOS(const QOS::SWriterQOS& qos_); - QOS::SWriterQOS GetQOS(); + .. code-block:: cpp + + int GetHostID(); + float GetProcessCpuUsage(); + unsigned long GetProcessMemory(); + + long long GetWClock(); + long long GetWBytes(); + long long GetRClock(); + long long GetRBytes(); - bool SetMaxBandwidthUDP(long bandwidth_); +- :file:`ecal_publisher.h`: - std::string GetTypeName() const; - std::string GetDescription() const; - -- :file:`ecal_subscriber.h`: - .. code-block:: cpp - - CSubscriber(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + bool SetTypeName(const std::string& topic_type_name_); + bool SetDescription(const std::string& topic_desc_); + + bool SetQOS(const QOS::SWriterQOS& qos_); + QOS::SWriterQOS GetQOS(); + + bool SetMaxBandwidthUDP(long bandwidth_); + + std::string GetTypeName() const; + std::string GetDescription() const; - bool SetQOS(const QOS::SReaderQOS& qos_); - QOS::SReaderQOS GetQOS(); +- :file:`ecal_subscriber.h`: - std::string GetTypeName() const; - std::string GetDescription() const; + .. code-block:: cpp + + CSubscriber(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + bool SetQOS(const QOS::SReaderQOS& qos_); + QOS::SReaderQOS GetQOS(); + + std::string GetTypeName() const; + std::string GetDescription() const; + + bool SetTimeout(int timeout_); - bool SetTimeout(int timeout_); - - :file:`ecal_tlayer.h`: - + .. code-block:: cpp - enum eTransportLayer - { - tlayer_none = 0, - tlayer_udp_mc = 1, - tlayer_shm = 4, - tlayer_tcp = 5, - tlayer_inproc = 42, //!< deprecated, whole layer will be removed in future eCAL versions - tlayer_all = 255 - }; - - struct ECAL_API STLayer - { - STLayer() - { - sm_udp_mc = smode_none; - sm_shm = smode_none; - sm_inproc = smode_none; - sm_tcp = smode_none; - } - eSendMode sm_udp_mc; - eSendMode sm_shm; - eSendMode sm_inproc; //!< deprecated, whole layer will be removed in future eCAL versions */ - eSendMode sm_tcp; - }; - + enum eTransportLayer + { + tlayer_none = 0, + tlayer_udp_mc = 1, + tlayer_shm = 4, + tlayer_tcp = 5, + tlayer_inproc = 42, //!< deprecated, whole layer will be removed in future eCAL versions + tlayer_all = 255 + }; + + struct ECAL_API STLayer + { + eSendMode sm_udp_mc; + eSendMode sm_shm; + eSendMode sm_inproc; //!< deprecated, whole layer will be removed in future eCAL versions */ + eSendMode sm_tcp; + }; + - :file:`ecal_util.h`: - + .. code-block:: cpp - - bool GetTopicTypeName(const std::string& topic_name_, std::string& topic_type_); - std::string GetTopicTypeName(const std::string& topic_name_); + + bool GetTopicTypeName(const std::string& topic_name_, std::string& topic_type_); + std::string GetTopicTypeName(const std::string& topic_name_); + + bool GetTopicDescription(const std::string& topic_name_, std::string& topic_desc_); + std::string GetTopicDescription(const std::string& topic_name_); + std::string GetDescription(const std::string& topic_name_); - bool GetTopicDescription(const std::string& topic_name_, std::string& topic_desc_); - std::string GetTopicDescription(const std::string& topic_name_); - std::string GetDescription(const std::string& topic_name_); - - :file:`msg/capnproto/dynamic.h`: - + .. code-block:: cpp - + std::string GetTypeName() const; - + - :file:`msg/capnproto/subscriber.h`: - + .. code-block:: cpp - + std::string GetTypeName() const; - + - :file:`msg/protobuf/publisher.h`: - + .. code-block:: cpp - + std::string GetTypeName() const; std::string GetDescription() const; - + - :file:`msg/string/publisher.h`: - + .. code-block:: cpp - + CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_); - + - :file:`msg/publisher.h`: - + .. code-block:: cpp - + CMsgPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); - + virtual std::string GetTypeName() const; virtual std::string GetDescription() const; - + - :file:`msg/subscriber.h`: - + .. code-block:: cpp CMsgSubscriber(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = "") - + virtual std::string GetTypeName() const; virtual std::string GetDescription() const; - + Added API ========= - :file:`ecal_subscriber_cimpl.h`: - + .. code-block:: cpp - - ECALC_API int eCAL_Sub_GetTypeName(ECAL_HANDLE handle_, void* buf_, int buf_len_); - ECALC_API int eCAL_Sub_GetEncoding(ECAL_HANDLE handle_, void* buf_, int buf_len_); - + + ECALC_API int eCAL_Sub_GetTypeName(ECAL_HANDLE handle_, void* buf_, int buf_len_); + ECALC_API int eCAL_Sub_GetEncoding(ECAL_HANDLE handle_, void* buf_, int buf_len_); + - :file:`ecal_util_cimpl.h`: .. code-block:: cpp - - ECALC_API int eCAL_Util_GetTopicEncoding(const char* topic_name_, void* topic_encoding_, int topic_encoding_len_); - ECALC_API int eCAL_Util_GetTopicDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); + + ECALC_API int eCAL_Util_GetTopicEncoding(const char* topic_name_, void* topic_encoding_, int topic_encoding_len_); + ECALC_API int eCAL_Util_GetTopicDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); From 0abe3aca8dd6ed3043fec530ef299320713ba12d Mon Sep 17 00:00:00 2001 From: Peter Guenschmann <73380451+Peguen@users.noreply.github.com> Date: Thu, 14 Mar 2024 11:28:41 +0100 Subject: [PATCH 3/3] Fixed indentations --- doc/rst/versions/5.13/deprecation.rst | 370 +++++++++++++------------- 1 file changed, 185 insertions(+), 185 deletions(-) diff --git a/doc/rst/versions/5.13/deprecation.rst b/doc/rst/versions/5.13/deprecation.rst index 82e0f61a26..4448672b79 100644 --- a/doc/rst/versions/5.13/deprecation.rst +++ b/doc/rst/versions/5.13/deprecation.rst @@ -28,307 +28,307 @@ Deprecated API .. code-block:: cpp - enum eCAL_Subscriber_Event - { - sub_event_none = 0, - sub_event_connected = 1, - sub_event_disconnected = 2, - sub_event_dropped = 3, - sub_event_timeout = 4, //!< deprecated, will be removed in future eCAL versions - sub_event_corrupted = 5, - sub_event_update_connection = 6, - }; - - struct SPubEventCallbackDataC - { - enum eCAL_Publisher_Event type; - long long time; - long long clock; - const char* tid; - const char* tname; - const char* tencoding; - const char* tdesc; - - const char* ttype; //!< deprecated, please use new tname + tencoding fields - }; - - struct SSubEventCallbackDataC - { - enum eCAL_Subscriber_Event type; - long long time; - long long clock; - const char* tid; - const char* tname; - const char* tencoding; - const char* tdesc; - - const char* ttype; //!< deprecated, please use new tname + tencoding fields - }; + enum eCAL_Subscriber_Event + { + sub_event_none = 0, + sub_event_connected = 1, + sub_event_disconnected = 2, + sub_event_dropped = 3, + sub_event_timeout = 4, //!< deprecated, will be removed in future eCAL versions + sub_event_corrupted = 5, + sub_event_update_connection = 6, + }; + + struct SPubEventCallbackDataC + { + enum eCAL_Publisher_Event type; + long long time; + long long clock; + const char* tid; + const char* tname; + const char* tencoding; + const char* tdesc; + + const char* ttype; //!< deprecated, please use new tname + tencoding fields + }; + + struct SSubEventCallbackDataC + { + enum eCAL_Subscriber_Event type; + long long time; + long long clock; + const char* tid; + const char* tname; + const char* tencoding; + const char* tdesc; + + const char* ttype; //!< deprecated, please use new tname + tencoding fields + }; - :file:`cimpl/ecal_client_cimpl.h`: .. code-block:: cpp - int eCAL_Client_AddResponseCallbackC(ECAL_HANDLE handle_, ResponseCallbackCT callback_, void* par_); + int eCAL_Client_AddResponseCallbackC(ECAL_HANDLE handle_, ResponseCallbackCT callback_, void* par_); - :file:`cimpl/ecal_init_cimpl.h`: .. code-block:: cpp - #define eCAL_Init_Publisher 0x01 - #define eCAL_Init_Subscriber 0x02 - #define eCAL_Init_Service 0x04 - #define eCAL_Init_Monitoring 0x08 - #define eCAL_Init_Logging 0x10 - #define eCAL_Init_TimeSync 0x20 - #define eCAL_Init_RPC 0x40 /*!< deprecated, will be removed in future eCAL versions */ - #define eCAL_Init_ProcessReg 0x80 + #define eCAL_Init_Publisher 0x01 + #define eCAL_Init_Subscriber 0x02 + #define eCAL_Init_Service 0x04 + #define eCAL_Init_Monitoring 0x08 + #define eCAL_Init_Logging 0x10 + #define eCAL_Init_TimeSync 0x20 + #define eCAL_Init_RPC 0x40 /*!< deprecated, will be removed in future eCAL versions */ + #define eCAL_Init_ProcessReg 0x80 - :file:`cimpl/ecal_log_cimpl.h`: .. code-block:: cpp - void eCAL_Logging_StartCoreTimer(); - void eCAL_Logging_StopCoreTimer(); - void eCAL_Logging_SetCoreTime(double time_); - double eCAL_Logging_GetCoreTime(); + void eCAL_Logging_StartCoreTimer(); + void eCAL_Logging_StopCoreTimer(); + void eCAL_Logging_SetCoreTime(double time_); + double eCAL_Logging_GetCoreTime(); - :file:`cimpl/ecal_monitoring_cimpl.h`: .. code-block:: cpp - int eCAL_Monitoring_PubMonitoring(int state_, const char* name_); - int eCAL_Monitoring_PubLogging(int state_, const char* name_); + int eCAL_Monitoring_PubMonitoring(int state_, const char* name_); + int eCAL_Monitoring_PubLogging(int state_, const char* name_); - :file:`cimpl/ecal_process_cimpl.h`: .. code-block:: cpp - int eCAL_Process_GetHostID(); - float eCAL_Process_GetProcessCpuUsage(); - unsigned long eCAL_Process_GetProcessMemory(); - - long long eCAL_Process_GetSClock(); - long long eCAL_Process_GetSBytes(); - long long eCAL_Process_GetWClock(); - long long eCAL_Process_GetWBytes(); - long long eCAL_Process_GetRClock(); - long long eCAL_Process_GetRBytes(); + int eCAL_Process_GetHostID(); + float eCAL_Process_GetProcessCpuUsage(); + unsigned long eCAL_Process_GetProcessMemory(); + + long long eCAL_Process_GetSClock(); + long long eCAL_Process_GetSBytes(); + long long eCAL_Process_GetWClock(); + long long eCAL_Process_GetWBytes(); + long long eCAL_Process_GetRClock(); + long long eCAL_Process_GetRBytes(); - :file:`cimpl/ecal_publisher_cimpl.h`: .. code-block:: cpp - int eCAL_Pub_SetQOS(ECAL_HANDLE handle_, struct SWriterQOSC qos_); - int eCAL_Pub_GetQOS(ECAL_HANDLE handle_, struct SWriterQOSC* qos_); - - int eCAL_Pub_SetMaxBandwidthUDP(ECAL_HANDLE handle_, long bandwidth_); + int eCAL_Pub_SetQOS(ECAL_HANDLE handle_, struct SWriterQOSC qos_); + int eCAL_Pub_GetQOS(ECAL_HANDLE handle_, struct SWriterQOSC* qos_); + + int eCAL_Pub_SetMaxBandwidthUDP(ECAL_HANDLE handle_, long bandwidth_); - :file:`cimpl/ecal_server_cimpl.h`: .. code-block:: cpp - int eCAL_Server_AddMethodCallbackC(ECAL_HANDLE handle_, const char* method_, const char* req_type_, const char* resp_type_, MethodCallbackCT callback_, void* par_); - int eCAL_Server_RemMethodCallbackC(ECAL_HANDLE handle_, const char* method_); + int eCAL_Server_AddMethodCallbackC(ECAL_HANDLE handle_, const char* method_, const char* req_type_, const char* resp_type_, MethodCallbackCT callback_, void* par_); + int eCAL_Server_RemMethodCallbackC(ECAL_HANDLE handle_, const char* method_); - :file:`cimpl/ecal_subscriber_cimpl.h`: .. code-block:: cpp - int eCAL_Sub_SetQOS(ECAL_HANDLE handle_, struct SReaderQOSC qos_); - int eCAL_Sub_GetQOS(ECAL_HANDLE handle_, struct SReaderQOSC* qos_); - - int eCAL_Sub_SetTimeout(ECAL_HANDLE handle_, int timeout_); + int eCAL_Sub_SetQOS(ECAL_HANDLE handle_, struct SReaderQOSC qos_); + int eCAL_Sub_GetQOS(ECAL_HANDLE handle_, struct SReaderQOSC* qos_); + + int eCAL_Sub_SetTimeout(ECAL_HANDLE handle_, int timeout_); - :file:`cimpl/ecal_tlayer_cimpl.h`: .. code-block:: cpp - enum eTransportLayerC - { - tlayer_none = 0, - tlayer_udp_mc = 1, - tlayer_shm = 4, - tlayer_tcp = 5, - tlayer_inproc = 42, /*!< deprecated, whole layer will be removed in future eCAL versions */ - tlayer_all = 255 - }; + enum eTransportLayerC + { + tlayer_none = 0, + tlayer_udp_mc = 1, + tlayer_shm = 4, + tlayer_tcp = 5, + tlayer_inproc = 42, /*!< deprecated, whole layer will be removed in future eCAL versions */ + tlayer_all = 255 + }; - :file:`cimpl/ecal_util_cimpl.h`: .. code-block:: cpp - int eCAL_Util_GetTypeName(const char* topic_name_, void* topic_type_, int topic_type_len_); - int eCAL_Util_GetDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); + int eCAL_Util_GetTypeName(const char* topic_name_, void* topic_type_, int topic_type_len_); + int eCAL_Util_GetDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); - :file:`ecal_callback.h`: .. code-block:: cpp - struct SPubEventCallbackData - { - eCAL_Publisher_Event type; - long long time; - long long clock; - std::string tid; - std::string ttype; //!< deprecated, please use new tdatatype field - std::string tdesc; //!< deprecated, please use new tdatatype field - - SDataTypeInformation tdatatype; - }; - - struct SSubEventCallbackData - { - eCAL_Subscriber_Event type; - long long time; - long long clock; - std::string tid; - std::string ttype; //!< deprecated, please use new tdatatype field - std::string tdesc; //!< deprecated, please use new tdatatype field - - SDataTypeInformation tdatatype; - }; + struct SPubEventCallbackData + { + eCAL_Publisher_Event type; + long long time; + long long clock; + std::string tid; + std::string ttype; //!< deprecated, please use new tdatatype field + std::string tdesc; //!< deprecated, please use new tdatatype field + + SDataTypeInformation tdatatype; + }; + + struct SSubEventCallbackData + { + eCAL_Subscriber_Event type; + long long time; + long long clock; + std::string tid; + std::string ttype; //!< deprecated, please use new tdatatype field + std::string tdesc; //!< deprecated, please use new tdatatype field + + SDataTypeInformation tdatatype; + }; - :file:`ecal_log.h`: .. code-block:: cpp - void StartCoreTimer(); - void StopCoreTimer(); - void SetCoreTime(double time_); - double GetCoreTime(); + void StartCoreTimer(); + void StopCoreTimer(); + void SetCoreTime(double time_); + double GetCoreTime(); - :file:`ecal_monitoring.h`: .. code-block:: cpp - int GetMonitoring(std::string& mon_); - int PubMonitoring(bool state_, std::string name_ = "ecal.monitoring"); - int PubLogging(bool state_, std::string name_ = "ecal.logging"); + int GetMonitoring(std::string& mon_); + int PubMonitoring(bool state_, std::string name_ = "ecal.monitoring"); + int PubLogging(bool state_, std::string name_ = "ecal.logging"); - :file:`ecal_process.h`: .. code-block:: cpp - int GetHostID(); - float GetProcessCpuUsage(); - unsigned long GetProcessMemory(); - - long long GetWClock(); - long long GetWBytes(); - long long GetRClock(); - long long GetRBytes(); + int GetHostID(); + float GetProcessCpuUsage(); + unsigned long GetProcessMemory(); + + long long GetWClock(); + long long GetWBytes(); + long long GetRClock(); + long long GetRBytes(); - :file:`ecal_publisher.h`: .. code-block:: cpp - CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - - bool SetTypeName(const std::string& topic_type_name_); - bool SetDescription(const std::string& topic_desc_); - - bool SetQOS(const QOS::SWriterQOS& qos_); - QOS::SWriterQOS GetQOS(); - - bool SetMaxBandwidthUDP(long bandwidth_); - - std::string GetTypeName() const; - std::string GetDescription() const; + CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + bool SetTypeName(const std::string& topic_type_name_); + bool SetDescription(const std::string& topic_desc_); + + bool SetQOS(const QOS::SWriterQOS& qos_); + QOS::SWriterQOS GetQOS(); + + bool SetMaxBandwidthUDP(long bandwidth_); + + std::string GetTypeName() const; + std::string GetDescription() const; - :file:`ecal_subscriber.h`: .. code-block:: cpp - CSubscriber(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - - bool SetQOS(const QOS::SReaderQOS& qos_); - QOS::SReaderQOS GetQOS(); - - std::string GetTypeName() const; - std::string GetDescription() const; - - bool SetTimeout(int timeout_); + CSubscriber(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + + bool SetQOS(const QOS::SReaderQOS& qos_); + QOS::SReaderQOS GetQOS(); + + std::string GetTypeName() const; + std::string GetDescription() const; + + bool SetTimeout(int timeout_); - :file:`ecal_tlayer.h`: .. code-block:: cpp - enum eTransportLayer - { - tlayer_none = 0, - tlayer_udp_mc = 1, - tlayer_shm = 4, - tlayer_tcp = 5, - tlayer_inproc = 42, //!< deprecated, whole layer will be removed in future eCAL versions - tlayer_all = 255 - }; - - struct ECAL_API STLayer - { - eSendMode sm_udp_mc; - eSendMode sm_shm; - eSendMode sm_inproc; //!< deprecated, whole layer will be removed in future eCAL versions */ - eSendMode sm_tcp; - }; + enum eTransportLayer + { + tlayer_none = 0, + tlayer_udp_mc = 1, + tlayer_shm = 4, + tlayer_tcp = 5, + tlayer_inproc = 42, //!< deprecated, whole layer will be removed in future eCAL versions + tlayer_all = 255 + }; + + struct ECAL_API STLayer + { + eSendMode sm_udp_mc; + eSendMode sm_shm; + eSendMode sm_inproc; //!< deprecated, whole layer will be removed in future eCAL versions */ + eSendMode sm_tcp; + }; - :file:`ecal_util.h`: .. code-block:: cpp - bool GetTopicTypeName(const std::string& topic_name_, std::string& topic_type_); - std::string GetTopicTypeName(const std::string& topic_name_); - - bool GetTopicDescription(const std::string& topic_name_, std::string& topic_desc_); - std::string GetTopicDescription(const std::string& topic_name_); - std::string GetDescription(const std::string& topic_name_); + bool GetTopicTypeName(const std::string& topic_name_, std::string& topic_type_); + std::string GetTopicTypeName(const std::string& topic_name_); + + bool GetTopicDescription(const std::string& topic_name_, std::string& topic_desc_); + std::string GetTopicDescription(const std::string& topic_name_); + std::string GetDescription(const std::string& topic_name_); - :file:`msg/capnproto/dynamic.h`: .. code-block:: cpp - std::string GetTypeName() const; + std::string GetTypeName() const; - :file:`msg/capnproto/subscriber.h`: .. code-block:: cpp - std::string GetTypeName() const; + std::string GetTypeName() const; - :file:`msg/protobuf/publisher.h`: .. code-block:: cpp - std::string GetTypeName() const; - std::string GetDescription() const; + std::string GetTypeName() const; + std::string GetDescription() const; - :file:`msg/string/publisher.h`: .. code-block:: cpp - CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_); + CPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_); - :file:`msg/publisher.h`: .. code-block:: cpp - CMsgPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); - - virtual std::string GetTypeName() const; - virtual std::string GetDescription() const; + CMsgPublisher(const std::string& topic_name_, const std::string& topic_type_, const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); + + virtual std::string GetTypeName() const; + virtual std::string GetDescription() const; - :file:`msg/subscriber.h`: .. code-block:: cpp - CMsgSubscriber(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); - bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = "") - - virtual std::string GetTypeName() const; - virtual std::string GetDescription() const; + CMsgSubscriber(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = ""); + bool Create(const std::string& topic_name_, const std::string& topic_type_ = "", const std::string& topic_desc_ = "") + + virtual std::string GetTypeName() const; + virtual std::string GetDescription() const; Added API ========= @@ -337,12 +337,12 @@ Added API .. code-block:: cpp - ECALC_API int eCAL_Sub_GetTypeName(ECAL_HANDLE handle_, void* buf_, int buf_len_); - ECALC_API int eCAL_Sub_GetEncoding(ECAL_HANDLE handle_, void* buf_, int buf_len_); + ECALC_API int eCAL_Sub_GetTypeName(ECAL_HANDLE handle_, void* buf_, int buf_len_); + ECALC_API int eCAL_Sub_GetEncoding(ECAL_HANDLE handle_, void* buf_, int buf_len_); - :file:`ecal_util_cimpl.h`: .. code-block:: cpp - ECALC_API int eCAL_Util_GetTopicEncoding(const char* topic_name_, void* topic_encoding_, int topic_encoding_len_); - ECALC_API int eCAL_Util_GetTopicDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_); + ECALC_API int eCAL_Util_GetTopicEncoding(const char* topic_name_, void* topic_encoding_, int topic_encoding_len_); + ECALC_API int eCAL_Util_GetTopicDescription(const char* topic_name_, void* topic_desc_, int topic_desc_len_);