VSM C++ SDK
Vehicle Specific Modules SDK
ugcs::vsm::Vehicle_request_spec< void > Class Template Reference

Specialization of request without payload. More...

#include <vehicle_request.h>

Inheritance diagram for ugcs::vsm::Vehicle_request_spec< void >:
ugcs::vsm::Vehicle_request

Public Types

typedef std::shared_ptr< Vehicle_request_specPtr
 Pointer type.
 
typedef std::weak_ptr< Vehicle_request_specWeak_ptr
 Pointer type.
 
- Public Types inherited from ugcs::vsm::Vehicle_request
enum  Result { Result::OK, Result::NOK }
 Request completion result. More...
 
typedef std::shared_ptr< Vehicle_requestPtr
 Pointer type.
 
typedef std::weak_ptr< Vehicle_requestWeak_ptr
 Pointer type.
 
typedef Callback_proxy< void, Result, std::string > Completion_handler
 Completion handler type of the request. More...
 

Public Member Functions

template<typename... Args>
 Vehicle_request_spec (Args &&...args)
 Constructor, forwards all argument to base class. More...
 
- Public Member Functions inherited from ugcs::vsm::Vehicle_request
 Vehicle_request (Completion_handler completion_handler, Request_completion_context::Ptr completion_ctx)
 Construct base request instance. More...
 
virtual ~Vehicle_request ()
 Make sure class is polymorphic. More...
 
void Set_completion_result (Result result, const std::string &)
 Set completion result to be used when Complete method is called. More...
 
void Complete ()
 Should be called when vehicle request is completed by the user. More...
 
void Abort ()
 Abort the request. More...
 
Result Get_completion_result ()
 Get current completion result. More...
 
bool Is_completed () const
 Check if the request was completed. More...
 
void Add_ref ()
 Add reference from user handle. More...
 
void Release_ref ()
 Release reference from user handle. More...
 

Static Public Member Functions

template<typename... Args>
static Ptr Create (Args &&...args)
 Create an instance. More...
 
- Static Public Member Functions inherited from ugcs::vsm::Vehicle_request
template<typename... Args>
static Ptr Create (Args &&...args)
 Create an instance. More...
 

Detailed Description

template<>
class ugcs::vsm::Vehicle_request_spec< void >

Specialization of request without payload.

Constructor & Destructor Documentation

template<typename... Args>
ugcs::vsm::Vehicle_request_spec< void >::Vehicle_request_spec ( Args &&...  args)
inline

Constructor, forwards all argument to base class.

Member Function Documentation

template<typename... Args>
static Ptr ugcs::vsm::Vehicle_request_spec< void >::Create ( Args &&...  args)
inlinestatic

Create an instance.


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