Skip to content

Math API

Version: 1.0.0

Status: ⚫⚪⚪

Math interface for Thunder framework.

(Defined with IMath in IMath.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the Math interface (version 1.0.0). It includes detailed specification about its methods provided.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

Math JSON-RPC interface.

Methods

The following methods are provided by the Math interface:

Math interface methods:

Method Description
add Perform addition on given inputs
sub Perform subtraction on given inputs

add method

Perform addition on given inputs.

Parameters

Name Type M/O Description
params object mandatory ...
params.a integer mandatory First input
params.b integer mandatory Second input

Result

Name Type M/O Description
result integer mandatory ...

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.add",
  "params": {
    "a": 0,
    "b": 0
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}

sub method

Perform subtraction on given inputs.

Parameters

Name Type M/O Description
params object mandatory ...
params.a integer mandatory First input
params.b integer mandatory Second input

Result

Name Type M/O Description
result integer mandatory ...

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.sub",
  "params": {
    "a": 0,
    "b": 0
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": 0
}