Skip to content

Latest commit

 

History

History
2843 lines (976 loc) · 26.5 KB

README.md

File metadata and controls

2843 lines (976 loc) · 26.5 KB
Raw

Robotics Language language reference

Index of keywords

Outputs, RosCpp

arguments

Definition:

arguments ( anything ) -> nothing

Alternative notations

notation example code
functional arguments()
xml <arguments> </arguments>

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

  • documentation: localisation

block

Definition:

block ( anything ) -> code block

Alternative notations

notation example code
functional block()
xml <block> </block>

Localisation available for:

language keyword

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

boolean

Alternative notations

notation example code
functional boolean()
xml <boolean> </boolean>

Localisation available for:

language keyword

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

content

Definition:

content ( anything ) -> nothing

Alternative notations

notation example code
functional content()
xml <content> </content>

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

  • documentation: localisation

cycle

Alternative notations

notation example code
functional cycle()
xml <cycle> </cycle>

Localisation available for:

language keyword
pt repetir

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

function

Definition:

function ( anything ) -> nothing

Alternative notations

notation example code
functional function()
xml <function> </function>

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

  • documentation: localisation

functionDefinition

Definition:

functionDefinition ( anything ) -> nothing

Alternative notations

notation example code
functional functionDefinition()
xml <functionDefinition> </functionDefinition>

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

  • documentation: localisation

integer

Alternative notations

notation example code
functional integer()
xml <integer> </integer>

Localisation available for:

language keyword
pt inteiro

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

natural

Alternative notations

notation example code
functional natural()
xml <natural> </natural>

Localisation available for:

language keyword
pt natural

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

print

Definition:

print ( string , ... , string ) -> nothing

Optional parameters:

name type
level string

Alternative notations

notation example code
functional print()
xml <print> </print>

Localisation available for:

language keyword
el εκτύπωσε
nl afdrukken
pt imprimir

❌ Missing:

  • documentation: title
  • documentation: description
  • documentation: usage

real

Alternative notations

notation example code
functional real()
xml <real> </real>

Localisation available for:

language keyword
pt real

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

return

Definition:

return ( anything ) -> nothing

Alternative notations

notation example code
functional return()
xml <return> </return>

Localisation available for:

language keyword

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

returns

Definition:

returns ( anything ) -> nothing

Alternative notations

notation example code
functional returns()
xml <returns> </returns>

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

  • documentation: localisation

string

Alternative notations

notation example code
functional string()
xml <string> </string>

Localisation available for:

language keyword
pt texto

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

Strings

Definition:

Strings ( anything ) -> nothing

Alternative notations

notation example code
functional Strings()
xml <Strings> </Strings>

Localisation available for:

language keyword
pt texto

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

variable

Definition:

variable ( anything ) -> nothing

Alternative notations

notation example code
functional variable()
xml <variable> </variable>

Localisation available for:

language keyword
pt variável

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

Transformers, TemporalLogic

always

Alternative notations

notation example code
functional always()
xml <always> </always>

Localisation available for:

language keyword
pt sempre

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

eventually

Alternative notations

notation example code
functional eventually()
xml <eventually> </eventually>

Localisation available for:

language keyword
pt eventualmente

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

Transformers, Base

anything

Definition:

anything ( anything ) -> nothing

Alternative notations

notation example code
functional anything()
xml <anything> </anything>

Localisation available for:

language keyword

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

defineFunction

Definition:

defineFunction ( anything ) -> nothing

Alternative notations

notation example code
functional defineFunction()
xml <defineFunction> </defineFunction>

Localisation available for:

language keyword

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

Event

Alternative notations

notation example code
functional Event()
xml <Event> </Event>

Localisation available for:

language keyword
pt eventos

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

events

Alternative notations

notation example code
functional events()
xml <events> </events>

Localisation available for:

language keyword
pt eventos

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

if

Alternative notations

notation example code
functional if()
xml <if> </if>

Localisation available for:

language keyword
pt se

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

node

The main software node

This is the main RoL node. Definitions, initialisation, events, etc., are defined here.

Usage:

node(
  name:"hello world",
  initialise(print("hello world"))
)

Definition:

node ( anything ) -> nothing

Optional parameters:

name type
definitions anything
rate real
initialise anything
name string
finalise anything

Alternative notations

notation example code
functional node()
xml <node> </node>

Localisation available for:

language keyword
el κόμβος
pt nó

option

Alternative notations

notation example code
functional option()
xml <option> </option>

Localisation available for:

language keyword
pt parâmetro

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

Signals

A time or event based signal

Defines a signal type.

Usage:

x in Signals(Reals,rostopic:'/test/signal')

Definition:

Signals ( anything ) -> nothing

Optional parameters:

name type
onNew block
onChange block
flow string
rosTopic string

Alternative notations

notation example code
functional Signals()
xml <Signals> </Signals>

Localisation available for:

language keyword
pt sinal

Time

Alternative notations

notation example code
functional Time()
xml <Time> </Time>

Localisation available for:

language keyword
pt eventos

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

Transformers, LinearAlgebra

and

Logical and operator

Is the logical AND function. It evaluates its arguments in order, giving False immediately if any of them are False, and True if they are all True.

Usage:

a = b and c

Definition:

and ( boolean ) -> boolean

Alternative notations

notation example code
infix type {'flat': True, 'order': 600, 'key': ['and', '\xe2\x88\xa7']} type
functional and()
xml <and> </and>

Localisation available for:

language keyword
pt e

❌ Missing:

  • definition: optional arguments

assign

Definition:

assign ( anything ) -> nothing

Alternative notations

notation example code
infix type {'order': 100, 'key': '='} type
functional assign()
xml <assign> </assign>

Localisation available for:

language keyword
pt atribuir

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

divide

Definition:

divide ( number ) -> None

Alternative notations

notation example code
infix type {'flat': True, 'order': 1200, 'key': '/'} type
functional divide()
xml <divide> </divide>

Localisation available for:

language keyword
pt dividir

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

equal

Definition:

equal ( number or string or boolean ) -> boolean

Alternative notations

notation example code
infix type {'order': 700, 'key': ['==', '\xe2\x89\xa1']} type
functional equal()
xml <equal> </equal>

Localisation available for:

language keyword
pt igual

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

larger

Definition:

larger ( number ) -> boolean

Alternative notations

notation example code
infix type {'order': 800, 'key': '>'} type
functional larger()
xml <larger> </larger>

Localisation available for:

language keyword
pt maior

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

largerEqual

Definition:

largerEqual ( number ) -> boolean

Alternative notations

notation example code
infix type {'order': 800, 'key': ['>=', '\xe2\x89\xa5']} type
functional largerEqual()
xml <largerEqual> </largerEqual>

Localisation available for:

language keyword
pt maiorIgual

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

minus

Definition:

minus ( number ) -> None

Alternative notations

notation example code
infix type {'flat': True, 'order': 1100, 'key': '-'} type
functional minus()
xml <minus> </minus>

Localisation available for:

language keyword
pt subtrair

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

negative

Number negation

Normal number or variable negation.

Usage:

a = -b

Definition:

negative ( anything ) -> None

Alternative notations

notation example code
prefix {'order': 1300, 'key': '-'} ( type )
functional negative()
xml <negative> </negative>

Localisation available for:

language keyword
pt negativo

❌ Missing:

  • definition: optional arguments

notEqual

Definition:

notEqual ( number or string or boolean ) -> boolean

Alternative notations

notation example code
infix type {'order': 700, 'key': ['!=', '\xe2\x89\xa0']} type
functional notEqual()
xml <notEqual> </notEqual>

Localisation available for:

language keyword
pt diferente

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

or

Definition:

or ( boolean ) -> boolean

Alternative notations

notation example code
functional or()
xml <or> </or>

Localisation available for:

language keyword
pt {'prefix': 'ou', 'infix': ['ou', '\xe2\x88\xa7']}

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

plus

Definition:

plus ( number or string ) -> None

Alternative notations

notation example code
infix type {'flat': True, 'order': 1100, 'key': '+'} type
functional plus()
xml <plus> </plus>

Localisation available for:

language keyword
pt adicionar

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

positive

Positive sign

Has no effect on sign.

Usage:

a = +b

Definition:

positive ( anything ) -> None

Alternative notations

notation example code
prefix {'order': 1300, 'key': '+'} ( type )
functional positive()
xml <positive> </positive>

Localisation available for:

language keyword
pt positivo

❌ Missing:

  • definition: optional arguments

smaller

Definition:

smaller ( number ) -> boolean

Alternative notations

notation example code
infix type {'order': 800, 'key': '<'} type
functional smaller()
xml <smaller> </smaller>

Localisation available for:

language keyword
pt menor

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

smallerEqual

Definition:

smallerEqual ( number ) -> boolean

Alternative notations

notation example code
infix type {'order': 800, 'key': ['<=', '\xe2\x89\xa4']} type
functional smallerEqual()
xml <smallerEqual> </smallerEqual>

Localisation available for:

language keyword
pt menorIgual

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

times

Number multiplication

Normal number, vector, or matrix multiplication.

Usage:

a = 2*3

Definition:

times ( number ) -> None

Alternative notations

notation example code
infix type {'flat': True, 'order': 1200, 'key': '*'} type
functional times()
xml <times> </times>

Localisation available for:

language keyword
pt multiplicar

❌ Missing:

  • definition: optional arguments

Inputs, RoL

associativeArray

Set

A set of values

Usage:

a = { b, c ,d }

Alternative notations

notation example code
functional associativeArray()
xml <associativeArray> </associativeArray>

Localisation available for:

language keyword

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type

Booleans

Definition:

Booleans ( anything ) -> nothing

Alternative notations

notation example code
functional Booleans()
xml <Booleans> </Booleans>

Localisation available for:

language keyword
pt boleano

❌ Missing:

  • definition: optional arguments

  • documentation: title

  • documentation: description

  • documentation: usage

element

Element of a set of type

Defines a variable to be an element of a set or a type. If a set is provided, then the variable takes the type of the elements of the set

Usage:

x in Reals

Definition:

element ( anything ) -> nothing

Alternative notations

notation example code
infix type {'order': 150, 'key': ['in', '\xe2\x88\x88']} type
functional element()
xml <element> </element>

Localisation available for:

language keyword
pt elemento

❌ Missing:

  • definition: optional arguments

Integers

Integer numbers type

A type representing integer numbers. Assumptions on the number of bits used by the compiler to represent an integer number is given as information in the editor.

Usage:

x in Integers

Definition:

Integers ( anything ) -> nothing

Optional parameters:

name type
bits integer

Alternative notations

notation example code
functional Integers()
xml <Integers> </Integers>

Localisation available for:

language keyword
pt inteiro

Naturals

Natural numbers type

A type representing natural numbers. Assumptions on the number of bits used by the compiler to represent an natural number is given as information in the editor.

Usage:

x in Naturals

Definition:

Naturals ( anything ) -> nothing

Optional parameters:

name type
bits natural

Alternative notations

notation example code
functional Naturals()
xml <Naturals> </Naturals>

Localisation available for:

language keyword
pt natural

Reals

Real numbers type

A type representing real numbers. Assumptions on the number of bits used by the compiler to represent a real number is given as information in the editor.

Usage:

x in Reals

Definition:

Reals ( anything ) -> nothing

Optional parameters:

name type
bits integer

Alternative notations

notation example code
functional Reals()
xml <Reals> </Reals>

Localisation available for:

language keyword
pt real

set

Alternative notations

notation example code
functional set()
xml <set> </set>

Localisation available for:

language keyword
pt conjunto

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

vector

Alternative notations

notation example code
functional vector()
xml <vector> </vector>

Localisation available for:

language keyword
pt vector

❌ Missing:

  • definition: argument types
  • definition: optional arguments
  • definition: return type
  • documentation: title
  • documentation: description
  • documentation: usage

Outputs matrix

keyword RoL RosCpp HTMLDocumentation RoLXML HTMLGUI Developer
always ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
and ✔ ✔ ✔ ⚠ ✔ ⚠
anything ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
arguments ⚠ ✔ ⚠ ⚠ ⚠ ⚠
assign ✔ ✔ ✔ ⚠ ✔ ⚠
associativeArray ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
block ⚠ ✔ ⚠ ⚠ ⚠ ⚠
boolean ✔ ✔ ✔ ⚠ ✔ ⚠
Booleans ✔ ✔ ✔ ⚠ ✔ ⚠
content ⚠ ✔ ⚠ ⚠ ⚠ ⚠
cycle ✔ ✔ ✔ ⚠ ✔ ⚠
defineFunction ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
divide ✔ ✔ ✔ ⚠ ⚠ ⚠
element ⚠ ✔ ⚠ ⚠ ⚠ ⚠
equal ✔ ✔ ✔ ⚠ ✔ ⚠
Event ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
events ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
eventually ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
function ⚠ ✔ ⚠ ⚠ ⚠ ⚠
functionDefinition ⚠ ✔ ⚠ ⚠ ⚠ ⚠
if ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
integer ✔ ✔ ✔ ⚠ ✔ ⚠
Integers ✔ ✔ ✔ ⚠ ✔ ⚠
larger ✔ ✔ ✔ ⚠ ✔ ⚠
largerEqual ✔ ✔ ✔ ⚠ ✔ ⚠
minus ✔ ✔ ✔ ⚠ ✔ ⚠
natural ✔ ✔ ✔ ⚠ ✔ ⚠
Naturals ✔ ✔ ✔ ⚠ ✔ ⚠
negative ✔ ✔ ✔ ⚠ ⚠ ⚠
node ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
notEqual ✔ ✔ ✔ ⚠ ✔ ⚠
option ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
or ✔ ✔ ✔ ⚠ ✔ ⚠
plus ✔ ✔ ✔ ⚠ ✔ ⚠
positive ✔ ✔ ✔ ⚠ ⚠ ⚠
print ✔ ✔ ✔ ⚠ ✔ ⚠
real ✔ ✔ ✔ ⚠ ✔ ⚠
Reals ✔ ✔ ✔ ⚠ ✔ ⚠
return ⚠ ✔ ⚠ ⚠ ⚠ ⚠
returns ⚠ ✔ ⚠ ⚠ ⚠ ⚠
set ⚠ ✔ ⚠ ⚠ ⚠ ⚠
Signals ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
smaller ✔ ✔ ✔ ⚠ ✔ ⚠
smallerEqual ✔ ✔ ✔ ⚠ ✔ ⚠
string ✔ ✔ ✔ ⚠ ✔ ⚠
Strings ✔ ✔ ✔ ⚠ ✔ ⚠
Time ⚠ ⚠ ⚠ ⚠ ⚠ ⚠
times ✔ ✔ ✔ ⚠ ⚠ ⚠
variable ✔ ✔ ✔ ⚠ ✔ ⚠
vector ⚠ ⚠ ⚠ ⚠ ⚠ ⚠