OpenCPN Partial API docs
Loading...
Searching...
No Matches
RestIoEvtData Struct Reference

Public Types

enum class  Cmd {
  Ping , Object , CheckWrite , ListRoutes ,
  ActivateRoute , ReverseRoute , PluginMsg
}

Static Public Member Functions

static RestIoEvtData CreateCmdData (const std::string &key, const std::string &src, const std::string &gpx_data, bool _force, bool _activate)
 Create a Cmd::Object instance.
static RestIoEvtData CreatePingData (const std::string &key, const std::string &src)
 Create a Cmd::Ping instance:
static RestIoEvtData CreateChkWriteData (const std::string &key, const std::string &src, const std::string &guid)
 Create a Cmd::CheckWrite instance.
static RestIoEvtData CreateListRoutesData (const std::string &key, const std::string &src)
 Create a Cmd::ListRoutes instance.
static RestIoEvtData CreateActivateRouteData (const std::string &key, const std::string &src, const std::string &guid)
static RestIoEvtData CreatePluginMsgData (const std::string &key, const std::string &src, const std::string &id, const std::string &msg)
static RestIoEvtData CreateReverseRouteData (const std::string &key, const std::string &src, const std::string &guid)

Public Attributes

enum RestIoEvtData::Cmd cmd
const std::string api_key
 Rest API parameter apikey.
const std::string source
 Rest API parameter source.
const std::string id
 rest API parameter id for PluginMsg.
const bool force
 rest API parameter force
const bool activate
 rest API parameter activate
const std::string payload
 GPX data for Cmd::Object, Guid for Cmd::CheckWrite, Activate, Reverse.

Detailed Description

Definition at line 69 of file rest_server.cpp.

Member Enumeration Documentation

◆ Cmd

enum class RestIoEvtData::Cmd
strong

Definition at line 70 of file rest_server.cpp.

Member Function Documentation

◆ CreateActivateRouteData()

RestIoEvtData RestIoEvtData::CreateActivateRouteData ( const std::string & key,
const std::string & src,
const std::string & guid )
inlinestatic

Definition at line 116 of file rest_server.cpp.

◆ CreateChkWriteData()

RestIoEvtData RestIoEvtData::CreateChkWriteData ( const std::string & key,
const std::string & src,
const std::string & guid )
inlinestatic

Create a Cmd::CheckWrite instance.

Definition at line 104 of file rest_server.cpp.

◆ CreateCmdData()

RestIoEvtData RestIoEvtData::CreateCmdData ( const std::string & key,
const std::string & src,
const std::string & gpx_data,
bool _force,
bool _activate )
inlinestatic

Create a Cmd::Object instance.

Definition at line 89 of file rest_server.cpp.

◆ CreateListRoutesData()

RestIoEvtData RestIoEvtData::CreateListRoutesData ( const std::string & key,
const std::string & src )
inlinestatic

Create a Cmd::ListRoutes instance.

Definition at line 111 of file rest_server.cpp.

◆ CreatePingData()

RestIoEvtData RestIoEvtData::CreatePingData ( const std::string & key,
const std::string & src )
inlinestatic

Create a Cmd::Ping instance:

Definition at line 98 of file rest_server.cpp.

◆ CreatePluginMsgData()

RestIoEvtData RestIoEvtData::CreatePluginMsgData ( const std::string & key,
const std::string & src,
const std::string & id,
const std::string & msg )
inlinestatic

Definition at line 122 of file rest_server.cpp.

◆ CreateReverseRouteData()

RestIoEvtData RestIoEvtData::CreateReverseRouteData ( const std::string & key,
const std::string & src,
const std::string & guid )
inlinestatic

Definition at line 129 of file rest_server.cpp.

Member Data Documentation

◆ activate

const bool RestIoEvtData::activate

rest API parameter activate

Definition at line 83 of file rest_server.cpp.

◆ api_key

const std::string RestIoEvtData::api_key

Rest API parameter apikey.

Definition at line 79 of file rest_server.cpp.

◆ force

const bool RestIoEvtData::force

rest API parameter force

Definition at line 82 of file rest_server.cpp.

◆ id

const std::string RestIoEvtData::id

rest API parameter id for PluginMsg.

Definition at line 81 of file rest_server.cpp.

◆ payload

const std::string RestIoEvtData::payload

GPX data for Cmd::Object, Guid for Cmd::CheckWrite, Activate, Reverse.

Definition at line 86 of file rest_server.cpp.

◆ source

const std::string RestIoEvtData::source

Rest API parameter source.

Definition at line 80 of file rest_server.cpp.

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