Temporizador personalizado

Introducción

The timer class is used to keep time and interact with a timer independent of the Brain’s timer.

Constructor de clases

timer();

Instructor de clase

Destroys the timer object and releases associated resources.

~timer();

Parámetros

Este constructor no acepta ningún parámetro.

Ejemplos

// Create a timer instance
timer myTimer = timer();

Funciones de los miembros

The timer class includes the following member functions:

• clear — Resets the timer to zero.

• time — Returns the elapsed time since the timer started.

• event — Calls a function after a specified number of milliseconds, with optional arguments.

Before calling any timer member functions, a timer instance must be created, as shown below:

/* This constructor is required to use a 
custom timer. Replace the values
as needed. */

// Create a timer instance
timer myTimer = timer();

clear

Pon el temporizador a cero.

Available Functions

void clear();

Parameters

Esta función no acepta ningún parámetro.

Return Values

Esta función no devuelve ningún valor.

Examples

while (true) {
  // Clear the timer every time the screen is pressed
  if (Brain.Screen.pressing()) {
    myTimer.clear();
  }
  Brain.Screen.clearScreen();
  Brain.Screen.setCursor(1, 1);
  Brain.Screen.print("Time: %.2f", myTimer.time(msec));
  wait(50, msec);
}

time

Devuelve el valor actual del temporizador.

Available Functions

1 — Devuelve el tiempo transcurrido en milisegundos.

uint32_t time() const;

2 — Devuelve el tiempo transcurrido en las unidades de tiempo especificadas.

double time(
    timeUnits units ) const;

Parameters

Parámetro	Tipo	Descripción
units	timeUnits	The units used to return the elapsed time: seconds / sec — seconds msec — milliseconds

Return Values

• The parameterless function (1) returns a uint32_t representing the elapsed time in milliseconds.

• The function with a timeUnits parameter (2) returns a double representing the elapsed time in the specified units.

Notes

• El temporizador comienza a contar cuando se crea el temporizador personalizado.

• Calling clear resets the timer value to zero.

Examples

// Display the timer as it ticks up
while (true) {
  Brain.Screen.clearScreen();
  Brain.Screen.setCursor(1, 1);
  Brain.Screen.print("Time: %.2f", myTimer.time(sec));

  wait(50, msec);
}

event

Registra una función de devolución de llamada que se ejecutará después de un retraso especificado.

Available Functions

1 — Registra una función de devolución de llamada para que se ejecute después de un retraso especificado y pasa un valor definido por el usuario a la función de devolución de llamada.

static void event(
    void (*callback)(void *),
    uint32_t value );

2 — Registra una función de devolución de llamada para que se ejecute después de un retraso especificado.

static void event(
    void (*callback)(void),
    uint32_t value );

Parameters

Parámetro	Tipo	Descripción
callback	void (*)(void *)	Una función que se llamará después del retraso especificado y que recibe un argumento definido por el usuario.
callback	void (*)(void)	Una función que se llamará después del retraso especificado.
value	uint32_t	El retraso, en milisegundos, antes de que se ejecute la función de devolución de llamada.

Return Values

Esta función no devuelve ningún valor.

Notes

• Esta función programa una llamada de retorno única; no se repite automáticamente.

• The callback function must return void.

• Se pueden programar varios eventos al mismo tiempo.

Examples

// Create a function to turn the screen orange
void turnOrange() {
  Brain.Screen.clearScreen(orange);
}

// Call turnOrange after 2 seconds
myTimer.event(turnOrange, 2000);