CanClientFactory inherites apollo::common::util::Factory. 更多...

#include <can_client_factory.h>

类 apollo::drivers::canbus::CanClientFactory 继承关系图:

apollo::drivers::canbus::CanClientFactory 的协作图:

Public 成员函数
void	RegisterCanClients ()
	Register the CAN clients of all brands.

std::unique_ptr< CanClient >	CreateCANClient (const CANCardParameter &parameter)
	Create a pointer to a specified brand of CAN client.

Public 成员函数继承自 apollo::common::util::Factory< CANCardParameter::CANCardBrand, CanClient >
bool	Register (const CANCardParameter::CANCardBrand &id, CanClient ()() creator)
	Registers the class given by the creator function, linking it to id.

bool	Contains (const CANCardParameter::CANCardBrand &id)

bool	Unregister (const CANCardParameter::CANCardBrand &id)
	Unregisters the class with the given identifier

void	Clear ()

bool	Empty () const

std::unique_ptr< CanClient >	CreateObjectOrNull (const CANCardParameter::CANCardBrand &id, Args &&... args)
	Creates and transfers membership of an object of type matching id.

std::unique_ptr< CanClient >	CreateObject (const CANCardParameter::CANCardBrand &id, Args &&... args)
	Creates and transfers membership of an object of type matching id.

详细描述

CanClientFactory inherites apollo::common::util::Factory.

在文件 can_client_factory.h 第 44 行定义.

成员函数说明

◆ CreateCANClient()

std::unique_ptr< CanClient > apollo::drivers::canbus::CanClientFactory::CreateCANClient ( const CANCardParameter & parameter )

Create a pointer to a specified brand of CAN client.

The brand is set in the parameter.

参数

parameter The parameter to create the CAN client.

返回: A pointer to the created CAN client.

在文件 can_client_factory.cc 第 53 行定义.

                                       {
  auto factory = CreateObject(parameter.brand());
  if (!factory) {
    AERROR << "Failed to create CAN client with parameter: "
           << parameter.DebugString();
  } else if (!factory->Init(parameter)) {
    AERROR << "Failed to initialize CAN card with parameter: "
           << parameter.DebugString();
  }
  return factory;
}

◆ RegisterCanClients()

void apollo::drivers::canbus::CanClientFactory::RegisterCanClients ( )

Register the CAN clients of all brands.

This function call the Function apollo::common::util::Factory::Register() for all of the CAN clients.

在文件 can_client_factory.cc 第 37 行定义.

                                          {
  AINFO << "CanClientFactory::RegisterCanClients";
  Register(CANCardParameter::FAKE_CAN,
           []() -> CanClient* { return new can::FakeCanClient(); });
#if USE_ESD_CAN
  AINFO << "register can: " << CANCardParameter::ESD_CAN;
  Register(CANCardParameter::ESD_CAN,
           []() -> CanClient* { return new can::EsdCanClient(); });
#endif
  Register(CANCardParameter::SOCKET_CAN_RAW,
           []() -> CanClient* { return new can::SocketCanClientRaw(); });
 
  Register(CANCardParameter::HERMES_CAN,
           []() -> CanClient* { return new can::HermesCanClient(); });
}

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

modules/drivers/canbus/can_client/can_client_factory.h
modules/drivers/canbus/can_client/can_client_factory.cc

Public 成员函数

详细描述

成员函数说明

◆ CreateCANClient()

◆ RegisterCanClients()