Apollo  6.0
Open source self driving car software
Public Types | Public Member Functions | Protected Attributes | List of all members
apollo::cyber::transport::Transmitter< M > Class Template Referenceabstract

#include <transmitter.h>

Inheritance diagram for apollo::cyber::transport::Transmitter< M >:
Inheritance graph
Collaboration diagram for apollo::cyber::transport::Transmitter< M >:
Collaboration graph

Public Types

using MessagePtr = std::shared_ptr< M >
 

Public Member Functions

 Transmitter (const RoleAttributes &attr)
 
virtual ~Transmitter ()
 
virtual void Enable ()=0
 
virtual void Disable ()=0
 
virtual void Enable (const RoleAttributes &opposite_attr)
 
virtual void Disable (const RoleAttributes &opposite_attr)
 
virtual bool Transmit (const MessagePtr &msg)
 
virtual bool Transmit (const MessagePtr &msg, const MessageInfo &msg_info)=0
 
uint64_t NextSeqNum ()
 
uint64_t seq_num () const
 
- Public Member Functions inherited from apollo::cyber::transport::Endpoint
 Endpoint (const RoleAttributes &attr)
 
virtual ~Endpoint ()
 
const Identityid () const
 
const RoleAttributes & attributes () const
 

Protected Attributes

uint64_t seq_num_
 
MessageInfo msg_info_
 
- Protected Attributes inherited from apollo::cyber::transport::Endpoint
bool enabled_
 
Identity id_
 
RoleAttributes attr_
 

Member Typedef Documentation

◆ MessagePtr

template<typename M >
using apollo::cyber::transport::Transmitter< M >::MessagePtr = std::shared_ptr<M>

Constructor & Destructor Documentation

◆ Transmitter()

template<typename M >
apollo::cyber::transport::Transmitter< M >::Transmitter ( const RoleAttributes &  attr)
explicit

◆ ~Transmitter()

template<typename M >
apollo::cyber::transport::Transmitter< M >::~Transmitter ( )
virtual

Member Function Documentation

◆ Disable() [1/2]

template<typename M >
virtual void apollo::cyber::transport::Transmitter< M >::Disable ( )
pure virtual

◆ Disable() [2/2]

template<typename M >
void apollo::cyber::transport::Transmitter< M >::Disable ( const RoleAttributes &  opposite_attr)
virtual

◆ Enable() [1/2]

template<typename M >
virtual void apollo::cyber::transport::Transmitter< M >::Enable ( )
pure virtual

◆ Enable() [2/2]

template<typename M >
void apollo::cyber::transport::Transmitter< M >::Enable ( const RoleAttributes &  opposite_attr)
virtual

◆ NextSeqNum()

template<typename M >
uint64_t apollo::cyber::transport::Transmitter< M >::NextSeqNum ( )
inline

◆ seq_num()

template<typename M >
uint64_t apollo::cyber::transport::Transmitter< M >::seq_num ( ) const
inline

◆ Transmit() [1/2]

template<typename M >
bool apollo::cyber::transport::Transmitter< M >::Transmit ( const MessagePtr msg)
virtual

◆ Transmit() [2/2]

template<typename M >
virtual bool apollo::cyber::transport::Transmitter< M >::Transmit ( const MessagePtr msg,
const MessageInfo msg_info 
)
pure virtual

Member Data Documentation

◆ msg_info_

template<typename M >
MessageInfo apollo::cyber::transport::Transmitter< M >::msg_info_
protected

◆ seq_num_

template<typename M >
uint64_t apollo::cyber::transport::Transmitter< M >::seq_num_
protected

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