Function eCAL::Util::GetDescription(const std::string&, std::string&)

Function eCAL::Util::GetDescription(const std::string&, std::string&)#

Function Documentation#

ECAL_API bool eCAL::Util::GetDescription(const std::string &topic_name_, std::string &topic_desc_)#

Gets description of the specified topic.

Deprecated:

Please use the method bool GetTopicDataTypeInformation(const std::string& topic_name_, SDataTypeInformation& topic_info_) instead. You can extract the descriptor from the SDataTypeInformation variable. This function will be removed in future eCAL versions.

Parameters:

  • topic_name_ – Topic name.

  • topic_desc_ – String to store description.

Returns:

True if succeeded.