Updateable.h File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for Updateable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Updateable

Macros
#define	UPDATE(item_)   ((item_)->updateable->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

Typedefs
typedef struct Updateable	Updateable

Enumerations
enum	type { SENSOR , SYSTEM }

Functions
void	initUpdateable (Updateable *updateable, const char *name, int hz)
void	defaultUpdate (void *self)
	Default update function for Updateable objects. More...
int	defaultStatus (struct Updateable *self)
	Default status function for Updateable objects. More...
int	defaultEnable (struct Updateable *self)
	Default enable function for Updateable objects. More...
int	defaultDisable (struct Updateable *self)
	Default disable function for Updateable objects. More...
int	writeDataToFileImplementation (const char *filename, void *self)
	Write data to a file. More...

Macro Definition Documentation

DISABLE

#define DISABLE

(

item_

)

((item_).updateable.disable(&item_.updateable))

Definition at line 11 of file Updateable.h.

DISABLED

#define DISABLED   0

Definition at line 14 of file Updateable.h.

ENABLE

#define ENABLE

(

item_

)

((item_).updateable.enable(&item_.updateable))

Definition at line 10 of file Updateable.h.

ENABLED

#define ENABLED   1

Definition at line 15 of file Updateable.h.

MAX_NAME_LENGTH

#define MAX_NAME_LENGTH   32

Definition at line 13 of file Updateable.h.

STATUS

#define STATUS

(

item_

)

((item_).updateable.status(&item_.updateable))

Definition at line 9 of file Updateable.h.

UPDATE

#define UPDATE

(

item_

)

((item_)->updateable->update(item_))

Definition at line 8 of file Updateable.h.

Typedef Documentation

Updateable

typedef struct Updateable Updateable

Enumeration Type Documentation

type

enum type

Enumerator
SENSOR
SYSTEM

Definition at line 17 of file Updateable.h.

             {
    SENSOR,
    SYSTEM
} type;

Function Documentation

defaultDisable()

int defaultDisable

(

struct Updateable *

self

)

Default disable function for Updateable objects.

Parameters

self	Pointer to the Updateable object.

Returns

int Status after disabling the Updateable object.

Definition at line 29 of file Updateable.c.

                                            {
    self->enabled = DISABLED;
    return SUCCESS;
}

Here is the caller graph for this function:

defaultEnable()

int defaultEnable

(

struct Updateable *

self

)

Default enable function for Updateable objects.

Parameters

self	Pointer to the Updateable object.

Returns

int Status after enabling the Updateable object.

Definition at line 24 of file Updateable.c.

                                           {
    self->enabled = ENABLED;
    return SUCCESS;
}

Here is the caller graph for this function:

defaultStatus()

int defaultStatus

(

struct Updateable *

self

)

Default status function for Updateable objects.

Parameters

self	Pointer to the Updateable object.

Returns

int Status of the Updateable object.

Definition at line 20 of file Updateable.c.

                                           {
    return self->enabled;
}

Here is the caller graph for this function:

defaultUpdate()

void defaultUpdate

(

void *

self

)

Default update function for Updateable objects.

Parameters

self	Pointer to the object to update.

Definition at line 16 of file Updateable.c.

                               {
    printf("Warning: Calling default Sensor Update Function.\n");
}

Here is the caller graph for this function:

initUpdateable()

void initUpdateable	(	Updateable *	updateable,
		const char *	name,
		int	hz
	)

Definition at line 6 of file Updateable.c.

                                                                      {
    strncpy(updateable->name, name, MAX_NAME_LENGTH);
    updateable->hz = hz;
    updateable->update = defaultUpdate;
    updateable->status = defaultStatus;
    updateable->enable = defaultEnable;
    updateable->disable = defaultDisable;
    updateable->enabled = DISABLED;
}

Here is the call graph for this function:

Here is the caller graph for this function:

writeDataToFileImplementation()

int writeDataToFileImplementation	(	const char *	filename,
		void *	self
	)

Write data to a file.

Parameters

filename	Name of the file to write to.
self	Pointer to the object whose data is to be written.

Returns

SUCCESS if the data was written, FAILURE otherwise.

Definition at line 34 of file Updateable.c.

                                                                    {
    FILE* file = fopen(filename, "w");
    if (!file) {
        perror("Failed to open file");
        return FAILURE;
    }
 
    printf("Writing data to file %s\n", filename);
 
    fclose(file);
    return FAILURE;
}