oc_module.h File Reference

The file with interface for the module library. More...

#include <stdbool.h>
#include <oc_stdtypes.h>
#include <oc_bits.h>
#include <oc_errors.h>

Go to the source code of this file.

Data Structures
struct	oC_Module_Registration_t

Functions
static bool	oC_Module_IsTurnedOn (oC_Module_t Module)
	checks if the module is turned on More...
static bool	oC_Module_TurnOnVerification (oC_ErrorCode_t *outErrorCode, oC_Module_t Module)
	verify if module is turned on More...
static bool	oC_Module_TurnOffVerification (oC_ErrorCode_t *outErrorCode, oC_Module_t Module)
	verify if module is turned off More...
static void	oC_Module_TurnOn (oC_Module_t Module)
	sets module as turned on More...
static void	oC_Module_TurnOff (oC_Module_t Module)
	sets module as turned off More...

Detailed Description

---

Author

Patryk Kubiak

Note

Copyright (C) 2015 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om

Copyright

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition in file oc_module.h.

Function Documentation

static bool oC_Module_IsTurnedOn ( oC_Module_t  Module )

inlinestatic

The function checks if the module is turned on

Parameters

Module

Module to check

Returns

true if module is turned on

Definition at line 121 of file oc_module.h.

static void oC_Module_TurnOff ( oC_Module_t  Module )

inlinestatic

The function turns off the module without checking if it is already enabled

Parameters

Module

index of the module to turn off

Definition at line 185 of file oc_module.h.

static bool oC_Module_TurnOffVerification ( oC_ErrorCode_t *  outErrorCode, oC_Module_t  Module  )

inlinestatic

The function for verification if module is not turned on

Parameters

outErrorCode	Reference to the error code variable
Module	Index of the module

Returns

true if module is turned off already

Definition at line 155 of file oc_module.h.

static void oC_Module_TurnOn ( oC_Module_t  Module )

inlinestatic

The function turns on the module without checking if it is already enabled

Parameters

Module

index of the module to turn on

Definition at line 170 of file oc_module.h.

static bool oC_Module_TurnOnVerification ( oC_ErrorCode_t *  outErrorCode, oC_Module_t  Module  )

inlinestatic

The function for turn-off function for verification if module is not turned off already

Parameters

outErrorCode	Reference to the error code variable
Module	Index of the module

Returns

true if module is turned on already

Definition at line 138 of file oc_module.h.