lsl_stream_info.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef LSL_STREAM_INFO_H
#define LSL_STREAM_INFO_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "lsl_global.h"
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <string>
#include <string_view>
 
//=============================================================================================================
// DEFINE NAMESPACE LSLLIB
//=============================================================================================================
 
namespace LSLLIB
{
 
//=============================================================================================================
enum class ChannelFormat : int
{
    Undefined = 0, 
    Float32 = 1,   
    Double64 = 2,  
    String = 3,    
    Int32 = 4,     
    Int16 = 5,     
    Int8 = 6,      
    Int64 = 7      
};
 
//=============================================================================================================
class LSLSHARED_EXPORT stream_info
{
public:
    //=========================================================================================================
    stream_info();
 
    //=========================================================================================================
    stream_info(const std::string& name,
                const std::string& type,
                int channel_count = 0,
                double nominal_srate = 0.0,
                ChannelFormat channel_format = ChannelFormat::Float32,
                const std::string& source_id = "");
 
    //=========================================================================================================
    stream_info(const stream_info& other) = default;
 
    //=========================================================================================================
    stream_info& operator=(const stream_info& other) = default;
 
    //=========================================================================================================

    [[nodiscard]] std::string name() const noexcept;

    [[nodiscard]] std::string type() const noexcept;

    [[nodiscard]] int channel_count() const noexcept;

    [[nodiscard]] double nominal_srate() const noexcept;

    [[nodiscard]] ChannelFormat channel_format() const noexcept;

    [[nodiscard]] std::string source_id() const noexcept;

 
    //=========================================================================================================

    [[nodiscard]] std::string uid() const noexcept;

    [[nodiscard]] std::string hostname() const noexcept;

 
    //=========================================================================================================

    [[nodiscard]] int data_port() const noexcept;

    [[nodiscard]] std::string data_host() const noexcept;

    void set_data_port(int port);

    void set_data_host(const std::string& host);

 
    //=========================================================================================================

    [[nodiscard]] std::string to_string() const;

    [[nodiscard]] static stream_info from_string(const std::string& data);

 
private:
    std::string m_name;             
    std::string m_type;             
    int m_channel_count;            
    double m_nominal_srate;         
    ChannelFormat m_channel_format; 
    std::string m_source_id;        
    std::string m_uid;              
    std::string m_hostname;         
 
    int m_data_port;         
    std::string m_data_host; 
};
 
} // namespace LSLLIB
 
#endif // LSL_STREAM_INFO_H