apollo::drivers::canbus::can::EsdCanClient Class Reference

The class which defines an ESD CAN client which inherits CanClient. More...

#include <esd_can_client.h>

Inheritance diagram for apollo::drivers::canbus::can::EsdCanClient:

Collaboration diagram for apollo::drivers::canbus::can::EsdCanClient:

Public Member Functions
bool	Init (const CANCardParameter &parameter) override
	Initialize the ESD CAN client by specified CAN card parameters. More...
virtual	~EsdCanClient ()
	Destructor. More...
apollo::common::ErrorCode	Start () override
	Start the ESD CAN client. More...
void	Stop () override
	Stop the ESD CAN client. More...
apollo::common::ErrorCode	Send (const std::vector< CanFrame > &frames, int32_t *const frame_num) override
	Send messages. More...
apollo::common::ErrorCode	Receive (std::vector< CanFrame > *const frames, int32_t *const frame_num) override
	Receive messages. More...
std::string	GetErrorString (const int32_t status) override
	Get the error string. More...
Public Member Functions inherited from apollo::drivers::canbus::CanClient
	CanClient ()=default
	Constructor. More...
virtual	~CanClient ()=default
	Destructor. More...
virtual apollo::common::ErrorCode	SendSingleFrame (const std::vector< CanFrame > &frames)
	Send a single message. More...

Additional Inherited Members
Protected Attributes inherited from apollo::drivers::canbus::CanClient
bool	is_started_ = false
	The CAN client is started. More...

Detailed Description

The class which defines an ESD CAN client which inherits CanClient.

Constructor & Destructor Documentation

~EsdCanClient()

virtual apollo::drivers::canbus::can::EsdCanClient::~EsdCanClient ( )

virtual

Destructor.

Member Function Documentation

GetErrorString()

std::string apollo::drivers::canbus::can::EsdCanClient::GetErrorString ( const int32_t  status )

overridevirtual

Get the error string.

Parameters

status

The status to get the error string.

Implements apollo::drivers::canbus::CanClient.

Init()

bool apollo::drivers::canbus::can::EsdCanClient::Init ( const CANCardParameter &  parameter )

overridevirtual

Initialize the ESD CAN client by specified CAN card parameters.

Parameters

parameter

CAN card parameters to initialize the CAN client.

Returns

If the initialization is successful.

Implements apollo::drivers::canbus::CanClient.

Receive()

apollo::common::ErrorCode apollo::drivers::canbus::can::EsdCanClient::Receive ( std::vector< CanFrame > *const  frames, int32_t *const  frame_num  )

overridevirtual

Receive messages.

Parameters

frames	The messages to receive.
frame_num	The amount of messages to receive.

Returns

The status of the receiving action which is defined by apollo::common::ErrorCode.

Implements apollo::drivers::canbus::CanClient.

Send()

apollo::common::ErrorCode apollo::drivers::canbus::can::EsdCanClient::Send ( const std::vector< CanFrame > &  frames, int32_t *const  frame_num  )

overridevirtual

Send messages.

Parameters

frames	The messages to send.
frame_num	The amount of messages to send.

Returns

The status of the sending action which is defined by apollo::common::ErrorCode.

Implements apollo::drivers::canbus::CanClient.

Start()

apollo::common::ErrorCode apollo::drivers::canbus::can::EsdCanClient::Start ( )

overridevirtual

Start the ESD CAN client.

Returns

The status of the start action which is defined by apollo::common::ErrorCode.

Implements apollo::drivers::canbus::CanClient.

Stop()

void apollo::drivers::canbus::can::EsdCanClient::Stop ( )

overridevirtual

Stop the ESD CAN client.

Implements apollo::drivers::canbus::CanClient.

---

The documentation for this class was generated from the following file:

• modules/drivers/canbus/can_client/esd/esd_can_client.h