setup.h File Reference

System Setup Header. More...

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

Go to the source code of this file.

Macros
#define	VERIFY(code, statement)    if ((code = statement)) return code
	Verifies that a statement is true.

Functions
int	Setup ()
int	Shutdown ()

Detailed Description

System Setup Header.

Author

Anti-Sway Team: Nguyen, Tri; Espinola, Malachi; Tevy, Vattanary; Hokenstad, Ethan; Neff, Callen)

Version

0.1

Date

2024-06-03

Copyright

Copyright (c) 2024

Macro Definition Documentation

VERIFY

#define VERIFY	(		code,
			statement )    if ((code = statement)) return code

Verifies that a statement is true.

Parameters

code	An integer varibale to hold the value of statement
statement	The statement to verify

Returns

false if statement is false

Postcondition

If a return is not executed, then code is now 0

Function Documentation

Setup()

int Setup

(

)

Sets up the entire System

Returns

0 upon success, negative otherwise

Here is the call graph for this function:

Shutdown()

int Shutdown

(

)

Shuts the entire System down

Returns

0 upon success, negative otherwise

Here is the call graph for this function: