Updateable.h

Go to the documentation of this file.

#ifndef RENSSELAERMOTORSPORT_UPDATEABLE_H
#define RENSSELAERMOTORSPORT_UPDATEABLE_H
 
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
#define UPDATE(item_)  ((item_)->update(item_))
#define STATUS(item_)  ((item_).updateable.status(&item_.updateable))
#define ENABLE(item_)  ((item_).updateable.enable(&item_.updateable))
#define DISABLE(item_)  ((item_).updateable.disable(&item_.updateable))
 
#define MAX_NAME_LENGTH 32
#define DISABLED 0
#define ENABLED 1
 
typedef enum {
    OUTPUT,
    SENSOR,
    SYSTEM
} UpdateableType;
 
typedef struct Updateable {
    char name[MAX_NAME_LENGTH];
    int hz;
    int enabled;
    int (*update)(struct Updateable* self);
    int (*status)(struct Updateable* self);
    int (*enable)(struct Updateable* self);
    int (*disable)(struct Updateable* self);
    UpdateableType type;
    void* child;
} Updateable;
 
/*
 * @brief Initializes the Updateable with initial settings.
 *
 * @param updateable Pointer to the Updateable struct.
 * @param name Name of the Updateable object.
 * @param hz Rate at which the Updateable is called (in Hz).
 * @param utype Type of the Updateable object (per UpdateableType).
 * @param child Pointer to the child object that this Updateable will manage.
 * @return void
*/
void initUpdateable(Updateable* updateable, const char* name, int hz, UpdateableType utype, void* child);
 
int defaultUpdate(struct Updateable* self);
 
int defaultStatus(struct Updateable* self);
 
int defaultEnable(struct Updateable* self);
 
int defaultDisable(struct Updateable* self);
 
int writeDataToFileImplementation(const char* filename, void* self);
 
#endif // RENSSELAERMOTORSPORT_UPDATEABLE_H