mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
af01ff3001
Fixed incorrect documentation for Task class, improved documentation for RobotDrive's drive() function (thanks to FRC Team 4579), and ran doxygen -u on cpp.doxy to remove deprecated XML_SCHEMA and XML_DTD tags Change-Id: I2f3fa4018d69b84e67376a5feb0eca43d5fa7623
55 lines
1.3 KiB
C++
55 lines
1.3 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) FIRST 2008. All Rights Reserved.
|
|
*/
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib. */
|
|
/*----------------------------------------------------------------------------*/
|
|
#pragma once
|
|
|
|
#include "ErrorBase.h"
|
|
#include "HAL/Task.hpp"
|
|
#include <iostream>
|
|
#include <string>
|
|
#include <thread>
|
|
|
|
#include <string>
|
|
|
|
/**
|
|
* Wrapper class around std::thread that allows changing thread priority
|
|
*/
|
|
class Task : public ErrorBase {
|
|
public:
|
|
static const uint32_t kDefaultPriority = 60;
|
|
|
|
Task() = default;
|
|
Task(const Task&) = delete;
|
|
Task& operator=(const Task&) = delete;
|
|
Task& operator=(Task&& task);
|
|
|
|
template <class Function, class... Args>
|
|
Task(const std::string& name, Function&& function, Args&&... args);
|
|
|
|
virtual ~Task();
|
|
|
|
bool joinable() const noexcept;
|
|
void join();
|
|
void detach();
|
|
std::thread::id get_id() const noexcept;
|
|
std::thread::native_handle_type native_handle();
|
|
|
|
bool Verify();
|
|
|
|
int32_t GetPriority();
|
|
|
|
bool SetPriority(int32_t priority);
|
|
|
|
std::string GetName() const;
|
|
|
|
private:
|
|
std::thread m_thread;
|
|
std::string m_taskName;
|
|
bool HandleError(STATUS results);
|
|
};
|
|
|
|
#include "Task.inc"
|