Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
uavcan::GenericPublisherBase Class Reference

#include <generic_publisher.hpp>

Inheritance diagram for uavcan::GenericPublisherBase:
Inheritance graph
[legend]

Public Member Functions

void allowAnonymousTransfers ()
 
INodegetNode () const
 
TransferPriority getPriority () const
 
MonotonicDuration getTxTimeout () const
 
void setPriority (const TransferPriority prio)
 
void setTxTimeout (MonotonicDuration tx_timeout)
 

Static Public Member Functions

static MonotonicDuration getMaxTxTimeout ()
 
static MonotonicDuration getMinTxTimeout ()
 

Protected Member Functions

int doInit (DataTypeKind dtkind, const char *dtname)
 
int genericPublish (const StaticTransferBufferImpl &buffer, TransferType transfer_type, NodeID dst_node_id, TransferID *tid, MonotonicTime blocking_deadline)
 
 GenericPublisherBase (INode &node, MonotonicDuration tx_timeout, MonotonicDuration max_transfer_interval)
 
TransferSendergetTransferSender ()
 
const TransferSendergetTransferSender () const
 
MonotonicTime getTxDeadline () const
 
bool isInited () const
 
 ~GenericPublisherBase ()
 

Private Attributes

INodenode_
 
TransferSender sender_
 
MonotonicDuration tx_timeout_
 

Additional Inherited Members

- Private Member Functions inherited from uavcan::Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 

Detailed Description

Definition at line 21 of file generic_publisher.hpp.

Constructor & Destructor Documentation

◆ GenericPublisherBase()

uavcan::GenericPublisherBase::GenericPublisherBase ( INode node,
MonotonicDuration  tx_timeout,
MonotonicDuration  max_transfer_interval 
)
inlineprotected

Definition at line 28 of file generic_publisher.hpp.

◆ ~GenericPublisherBase()

uavcan::GenericPublisherBase::~GenericPublisherBase ( )
inlineprotected

Definition at line 40 of file generic_publisher.hpp.

Member Function Documentation

◆ allowAnonymousTransfers()

void uavcan::GenericPublisherBase::allowAnonymousTransfers ( )
inline

By default, attempt to send a transfer from passive mode will result in an error ErrPassive. This option allows to enable sending anonymous transfers from passive mode.

Definition at line 65 of file generic_publisher.hpp.

◆ doInit()

int uavcan::GenericPublisherBase::doInit ( DataTypeKind  dtkind,
const char *  dtname 
)
protected

Definition at line 15 of file uc_generic_publisher.cpp.

◆ genericPublish()

int uavcan::GenericPublisherBase::genericPublish ( const StaticTransferBufferImpl buffer,
TransferType  transfer_type,
NodeID  dst_node_id,
TransferID tid,
MonotonicTime  blocking_deadline 
)
protected

Definition at line 41 of file uc_generic_publisher.cpp.

◆ getMaxTxTimeout()

static MonotonicDuration uavcan::GenericPublisherBase::getMaxTxTimeout ( )
inlinestatic

Definition at line 56 of file generic_publisher.hpp.

◆ getMinTxTimeout()

static MonotonicDuration uavcan::GenericPublisherBase::getMinTxTimeout ( )
inlinestatic

Definition at line 55 of file generic_publisher.hpp.

◆ getNode()

INode& uavcan::GenericPublisherBase::getNode ( ) const
inline

Definition at line 76 of file generic_publisher.hpp.

◆ getPriority()

TransferPriority uavcan::GenericPublisherBase::getPriority ( ) const
inline

Priority of outgoing transfers.

Definition at line 73 of file generic_publisher.hpp.

◆ getTransferSender() [1/2]

TransferSender& uavcan::GenericPublisherBase::getTransferSender ( )
inlineprotected

Definition at line 51 of file generic_publisher.hpp.

◆ getTransferSender() [2/2]

const TransferSender& uavcan::GenericPublisherBase::getTransferSender ( ) const
inlineprotected

Definition at line 52 of file generic_publisher.hpp.

◆ getTxDeadline()

MonotonicTime uavcan::GenericPublisherBase::getTxDeadline ( ) const
protected

Definition at line 36 of file uc_generic_publisher.cpp.

◆ getTxTimeout()

MonotonicDuration uavcan::GenericPublisherBase::getTxTimeout ( ) const
inline

Definition at line 58 of file generic_publisher.hpp.

◆ isInited()

bool uavcan::GenericPublisherBase::isInited ( ) const
protected

Definition at line 10 of file uc_generic_publisher.cpp.

◆ setPriority()

void uavcan::GenericPublisherBase::setPriority ( const TransferPriority  prio)
inline

Definition at line 74 of file generic_publisher.hpp.

◆ setTxTimeout()

void uavcan::GenericPublisherBase::setTxTimeout ( MonotonicDuration  tx_timeout)

Definition at line 56 of file uc_generic_publisher.cpp.

Member Data Documentation

◆ node_

INode& uavcan::GenericPublisherBase::node_
private

Definition at line 25 of file generic_publisher.hpp.

◆ sender_

TransferSender uavcan::GenericPublisherBase::sender_
private

Definition at line 23 of file generic_publisher.hpp.

◆ tx_timeout_

MonotonicDuration uavcan::GenericPublisherBase::tx_timeout_
private

Definition at line 24 of file generic_publisher.hpp.


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


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:04