Linux makeNode() helper overload

This commit is contained in:
Pavel Kirienko
2016-06-13 00:46:13 +03:00
parent 59bcde5868
commit a19dfd56dc
6 changed files with 102 additions and 35 deletions
@@ -35,6 +35,28 @@ public:
int getErrno() const { return errno_; }
};
/**
* This type is thrown when a Libuavcan API method exits with error.
* The error code is stored in the exception object and is avialable via @ref getLibuavcanErrorCode().
*/
class LibuavcanErrorException : public Exception
{
const std::int16_t error_;
static std::string makeErrorString(std::int16_t e)
{
return "Libuavcan error (" + std::to_string(e) + ")";
}
public:
explicit LibuavcanErrorException(std::int16_t uavcan_error_code) :
Exception(makeErrorString(uavcan_error_code)),
error_(std::abs(uavcan_error_code))
{ }
std::int16_t getLibuavcanErrorCode() const { return error_; }
};
/**
* This exception is thrown when all available interfaces become down.
*/
@@ -381,6 +381,49 @@ static inline NodePtr makeNode(const std::shared_ptr<uavcan::ICanDriver>& can_dr
return NodePtr(new Node(dp));
}
/**
* This function extends the other two overloads in such a way that it instantiates and initializes
* the node immediately; if initialization fails, it throws.
*
* If NodeID is not provided, it will not be initialized, and therefore the node will be started in
* listen-only (i.e. silent) mode. The node can be switched to normal (i.e. non-silent) mode at any
* later time by calling setNodeID() explicitly. Read the Node class docs for more info.
*
* Clock adjustment mode will be detected automatically unless provided explicitly.
*
* @throws uavcan_linux::Exception, uavcan_linux::LibuavcanErrorException.
*/
template <typename DriverType>
static inline NodePtr makeNode(const DriverType& driver,
const uavcan::NodeStatusProvider::NodeName& name,
const uavcan::protocol::SoftwareVersion& software_version,
const uavcan::protocol::HardwareVersion& hardware_version,
const uavcan::NodeID node_id = uavcan::NodeID(),
const uavcan::TransferPriority node_status_transfer_priority =
uavcan::TransferPriority::Default,
ClockAdjustmentMode clock_adjustment_mode =
SystemClock::detectPreferredClockAdjustmentMode())
{
NodePtr node = makeNode(driver, clock_adjustment_mode);
node->setName(name);
node->setSoftwareVersion(software_version);
node->setHardwareVersion(hardware_version);
if (node_id.isValid())
{
node->setNodeID(node_id);
}
const auto res = node->start(node_status_transfer_priority);
if (res < 0)
{
throw LibuavcanErrorException(res);
}
return node;
}
/**
* Use this function to create a sub-node instance with default SocketCAN driver.
* It accepts the list of interface names to use for the new node, e.g. "can1", "vcan2", "slcan0".
@@ -408,4 +451,25 @@ static inline SubNodePtr makeSubNode(const std::shared_ptr<uavcan::ICanDriver>&
return SubNodePtr(new SubNode(dp));
}
/**
* This function extends the other two overloads in such a way that it instantiates the node
* and sets its Node ID immediately.
*
* Clock adjustment mode will be detected automatically unless provided explicitly.
*
* @throws uavcan_linux::Exception, uavcan_linux::LibuavcanErrorException.
*/
template <typename DriverType>
static inline SubNodePtr makeSubNode(const DriverType& driver,
const uavcan::NodeID node_id,
const uavcan::TransferPriority node_status_transfer_priority =
uavcan::TransferPriority::Default,
ClockAdjustmentMode clock_adjustment_mode =
SystemClock::detectPreferredClockAdjustmentMode())
{
SubNodePtr sub_node = makeSubNode(driver, clock_adjustment_mode);
sub_node->setNodeID(node_id);
return sub_node;
}
}