Public Member Functions | Private Types | Private Attributes | List of all members
uavcan_linux::Node Class Reference

#include <helpers.hpp>

Inheritance diagram for uavcan_linux::Node:
Inheritance graph
[legend]

Public Member Functions

 Node (DriverPackPtr driver_pack)
 
 Node (uavcan::ICanDriver &can_driver, uavcan::ISystemClock &clock)
 
- Public Member Functions inherited from uavcan_linux::NodeBase< uavcan::Node< NodeMemPoolSize > >
DriverPackPtrgetDriverPack ()
 
const DriverPackPtrgetDriverPack () const
 
BlockingServiceClientPtr< DataType > makeBlockingServiceClient ()
 
PublisherPtr< DataType > makePublisher (uavcan::MonotonicDuration tx_timeout=uavcan::Publisher< DataType >::getDefaultTxTimeout())
 
ServiceClientPtr< DataType > makeServiceClient (const typename uavcan::ServiceClient< DataType >::Callback &cb)
 
ServiceServerPtr< DataType > makeServiceServer (const typename uavcan::ServiceServer< DataType >::Callback &cb)
 
SubscriberPtr< DataType > makeSubscriber (const typename uavcan::Subscriber< DataType >::Callback &cb)
 
TimerPtr makeTimer (uavcan::MonotonicDuration period, const typename uavcan::Timer::Callback &cb)
 
TimerPtr makeTimer (uavcan::MonotonicTime deadline, const typename uavcan::Timer::Callback &cb)
 
 NodeBase (DriverPackPtr driver_pack)
 
 NodeBase (uavcan::ICanDriver &can_driver, uavcan::ISystemClock &clock)
 
- Public Member Functions inherited from uavcan::Node< NodeMemPoolSize >
virtual RemoveReference< Allocator >::Type & getAllocator ()
 
const protocol::HardwareVersion & getHardwareVersion () const
 
uint64_t getInternalFailureCount () const
 
LoggergetLogger ()
 
const NodeStatusProvider::NodeNamegetName () const
 
NodeStatusProvidergetNodeStatusProvider ()
 
RestartRequestServergetRestartRequestServer ()
 
virtual SchedulergetScheduler ()
 
virtual const SchedulergetScheduler () const
 
const protocol::SoftwareVersion & getSoftwareVersion () const
 
bool isStarted () const
 
 Node (ICanDriver &can_driver, ISystemClock &system_clock)
 
 Node (ICanDriver &can_driver, ISystemClock &system_clock, IPoolAllocator &allocator)
 
void setHardwareVersion (const protocol::HardwareVersion &version)
 
void setHealthCritical ()
 
void setHealthError ()
 
void setHealthOk ()
 
void setHealthWarning ()
 
void setModeInitialization ()
 
void setModeMaintenance ()
 
void setModeOfflineAndPublish ()
 
void setModeOperational ()
 
void setModeSoftwareUpdate ()
 
void setName (const NodeStatusProvider::NodeName &name)
 
void setRestartRequestHandler (IRestartRequestHandler *handler)
 
void setSoftwareVersion (const protocol::SoftwareVersion &version)
 
void setVendorSpecificStatusCode (NodeStatusProvider::VendorSpecificStatusCode code)
 
int spin (MonotonicDuration duration)
 
int spin (MonotonicTime deadline)
 
int spinOnce ()
 
int start (const TransferPriority node_status_transfer_priority=TransferPriority::Default)
 
void logDebug (const char *source, const char *format, Args... args)
 
void logInfo (const char *source, const char *format, Args... args)
 
void logWarning (const char *source, const char *format, Args... args)
 
void logError (const char *source, const char *format, Args... args)
 
- Public Member Functions inherited from uavcan::INode
DispatchergetDispatcher ()
 
const DispatchergetDispatcher () const
 
MonotonicTime getMonotonicTime () const
 
NodeID getNodeID () const
 
virtual const SchedulergetScheduler () const =0
 
ISystemClockgetSystemClock ()
 
UtcTime getUtcTime () const
 
int injectTxFrame (const CanFrame &frame, MonotonicTime tx_deadline, uint8_t iface_mask, CanIOFlags flags=0)
 
void installRxFrameListener (IRxFrameListener *lst)
 
bool isPassiveMode () const
 
void removeRxFrameListener ()
 
bool setNodeID (NodeID nid)
 
int spin (MonotonicDuration duration)
 
int spin (MonotonicTime deadline)
 
int spinOnce ()
 
virtual ~INode ()
 

Private Types

typedef NodeBase< uavcan::Node< NodeMemPoolSize > > Base
 

Private Attributes

DefaultLogSink log_sink_
 

Additional Inherited Members

- Protected Member Functions inherited from uavcan::Node< NodeMemPoolSize >
virtual void registerInternalFailure (const char *msg)
 
- Static Protected Member Functions inherited from uavcan_linux::NodeBase< uavcan::Node< NodeMemPoolSize > >
static void enforce (int error, const std::string &msg)
 
static std::string getDataTypeName ()
 
- Protected Attributes inherited from uavcan_linux::NodeBase< uavcan::Node< NodeMemPoolSize > >
DriverPackPtr driver_pack_
 

Detailed Description

Wrapper for uavcan::Node with some additional convenience functions. Note that this wrapper adds stderr log sink to uavcan::Logger, which can be removed if needed. Do not instantiate this class directly; instead use the factory functions defined below.

Definition at line 308 of file platform_specific_components/linux/libuavcan/include/uavcan_linux/helpers.hpp.

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Node() [1/2]

uavcan_linux::Node::Node ( uavcan::ICanDriver can_driver,
uavcan::ISystemClock clock 
)
inline

Simple forwarding constructor, compatible with uavcan::Node.

Definition at line 318 of file platform_specific_components/linux/libuavcan/include/uavcan_linux/helpers.hpp.

◆ Node() [2/2]

uavcan_linux::Node::Node ( DriverPackPtr  driver_pack)
inlineexplicit

Takes ownership of the driver container via the shared pointer.

Definition at line 327 of file platform_specific_components/linux/libuavcan/include/uavcan_linux/helpers.hpp.

Member Data Documentation

◆ log_sink_

DefaultLogSink uavcan_linux::Node::log_sink_
private

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


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