ExternalSystem.c File Reference

#include "../../Inc/Systems/ExternalSystem.h"
#include "../../Inc/Utils/Common.h"
#include "../../Inc/Utils/Updateable.h"
#include "../../Inc/Scheduler/Task.h"

Include dependency graph for ExternalSystem.c:

Go to the source code of this file.

Functions
void	initExternalSystem (ExternalSystem *external, const char *name, int hz, ExternalType type, int(*updateExternal)(ExternalSystem *external), int(*check_heartbeat)(void *self), void *child)
int	e_defaultUpdate (Updateable *updateable)

Function Documentation

e_defaultUpdate()

int e_defaultUpdate

(

Updateable *

updateable

)

Default update function for ExternalSystem objects.

Parameters

task	Pointer to the task to update.

Returns

int _SUCCESS or _FAILURE.

Definition at line 20 of file ExternalSystem.c.

                                            {
    // Cast the child pointer to a external system
    System* system = (System*)updateable->child;
    ExternalSystem* external = (ExternalSystem*)system->child;
 
    // Perform the heartbeat check
    if (external->check_heartbeat(external) == _FAILURE) {
        return _FAILURE;
    }
 
    // Perform the external system update
    if (external->updateExternal(external) == _FAILURE) {
        return _FAILURE;
    }
 
    return _SUCCESS;
}

Here is the caller graph for this function:

initExternalSystem()

void initExternalSystem	(	ExternalSystem *	external,
		const char *	name,
		int	hz,
		ExternalType	type,
		int(*)(ExternalSystem *external)	updateExternal,
		int(*)(void *self)	check_heartbeat,
		void *	child
	)

Initializes the External System with initial settings.

Parameters

external	A pointer to the ExternalSystem structure.
name	The name of the external system.
hz	Rate at which the external system is called (in hz).
type	The type of external system (per ExternalType).
updateExternal	The function to update the external system.
check_heartbeat	The function to check the heartbeat of the external system.
child	Pointer to the child struct.

Definition at line 6 of file ExternalSystem.c.

                                                                         {
    initSystem(&external->system, name, hz, EXTERNAL, external);
    external->type = type;
    external->comms = NULL;
    external->check_heartbeat = check_heartbeat;
    external->updateExternal = updateExternal;
    external->child = child;
 
    // Set the updateable function to generic external system update
    external->system.updateable.update = e_defaultUpdate;
}

Here is the call graph for this function:

Here is the caller graph for this function: