CyberChannReader< T > 模板类 参考

#include <channel_reader.h>

CyberChannReader< T > 的协作图:

Public 成员函数
	CyberChannReader (void)
	~CyberChannReader ()
void	CloseChannel (void)
bool	InstallCallbackAndOpen (CyberChannelCallback< T > channelCallback, const std::string &channelName, const std::string &nodeName)
bool	InstallCallback (CyberChannelCallback< T > channelCallback)
bool	OpenChannel (const std::string &channelName, const std::string &nodeName)
const std::string &	NodeName (void) const

详细描述

template<typename T>
class CyberChannReader< T >

在文件 channel_reader.h 第 30 行定义.

构造及析构函数说明

CyberChannReader()

template<typename T >

CyberChannReader< T >::CyberChannReader ( void  )

inline

在文件 channel_reader.h 第 32 行定义.

: channel_callback_(nullptr), channel_node_(nullptr) {}

~CyberChannReader()

template<typename T >

CyberChannReader< T >::~CyberChannReader ( )

inline

在文件 channel_reader.h 第 34 行定义.

{ CloseChannel(); }

成员函数说明

CloseChannel()

template<typename T >

void CyberChannReader< T >::CloseChannel ( void  )

inline

在文件 channel_reader.h 第 36 行定义.

                          {
    if (channel_reader_ != nullptr) {
      channel_reader_.reset();
    }
 
    if (channel_node_ != nullptr) {
      channel_node_.reset();
    }
  }

InstallCallback()

template<typename T >

bool CyberChannReader< T >::InstallCallback ( CyberChannelCallback< T >  channelCallback )

inline

在文件 channel_reader.h 第 53 行定义.

                                                                {
    if (channelCallback != nullptr) {
      channel_callback_ = channelCallback;
      return true;
    } else {
      std::cerr << "Parameter readerCallback is null" << std::endl;
      return false;
    }
  }

InstallCallbackAndOpen()

template<typename T >

bool CyberChannReader< T >::InstallCallbackAndOpen ( CyberChannelCallback< T >  channelCallback, const std::string &  channelName, const std::string &  nodeName  )

inline

在文件 channel_reader.h 第 46 行定义.

                                                         {
    return InstallCallback(channelCallback) &&
           OpenChannel(channelName, nodeName);
  }

NodeName()

template<typename T >

const std::string & CyberChannReader< T >::NodeName ( void  ) const

inline

在文件 channel_reader.h 第 78 行定义.

{ return channel_node_->Name(); }

OpenChannel()

template<typename T >

bool CyberChannReader< T >::OpenChannel ( const std::string &  channelName, const std::string &  nodeName  )

inline

在文件 channel_reader.h 第 63 行定义.

                                              {
    if (channelName.empty() || nodeName.empty()) {
      std::cerr << "Channel Name or Node Name must be not empty" << std::endl;
      return false;
    }
 
    if (channel_node_ != nullptr || channel_reader_ != nullptr ||
        !channel_callback_) {
      return false;
    }
 
    return CreateChannel(channelName, nodeName);
  }

---

该类的文档由以下文件生成:

• modules/tools/visualizer/channel_reader.h