SysIo  1.9.0
Embedded Library and tools

Detailed Description

Collaboration diagram for Gpio:

Classes

class  Sysio::Gpio
 Classe Gpio. More...
 
class  Sysio::Gpio::Descriptor
 Descripteur d'un GPIO. More...
 

Functions

AccessLayer Sysio::Gpio::accessLayer () const
 Lecture de la couche d'accès utilisée.
 
void Sysio::Gpio::close ()
 Fermeture du GPIO.
 
Connector * Sysio::Gpio::connector (int conn) const
 Connecteur. More...
 
const std::map< int, std::shared_ptr< Connector > > & Sysio::Gpio::connector ()
 Liste des connecteurs de la carte. More...
 
int Sysio::Gpio::connectors () const
 Nombre de connecteurs.
 
Device * Sysio::Gpio::device () const
 Accès à la couche matérielle.
 
 Sysio::Gpio::Gpio (AccessLayer layer=AccessLayerAuto)
 Constructeur par défaut. More...
 
 Sysio::Gpio::Gpio (Device *device, AccessLayer layer)
 Constructeur sous jacent. More...
 
bool Sysio::Gpio::isDebug () const
 Indique si le mode mise au point est actif.
 
bool Sysio::Gpio::isOpen () const
 Indique si ouvert.
 
const std::string & Sysio::Gpio::name () const
 Nom de la carte.
 
Pin::Numbering Sysio::Gpio::numbering () const
 Numérotation en cours. More...
 
const std::string & Sysio::Gpio::numberingName () const
 Nom de la numérotation en cours.
 
bool Sysio::Gpio::open ()
 Ouverture. More...
 
Pin & Sysio::Gpio::pin (int num) const
 Broche GPIO. More...
 
const std::map< int, std::shared_ptr< Pin > > & Sysio::Gpio::pin ()
 Liste des broches de type GPIO. More...
 
bool Sysio::Gpio::releaseOnClose () const
 Lecture la libération des broches à la fermeture. More...
 
void Sysio::Gpio::setDebug (bool enable)
 Active le mode mise au point. More...
 
void Sysio::Gpio::setNumbering (Pin::Numbering numbering)
 Modifie la numérotation.
 
void Sysio::Gpio::setReleaseOnClose (bool enable)
 Modifie la libération des broches à la fermeture. More...
 
int Sysio::Gpio::size () const
 Nombre de broches de type GPIO sur la carte(TypeGpio)
 
virtual Sysio::Gpio::~Gpio ()
 Destructeur.
 

Variables

std::vector< Connector::Descriptor > Sysio::Gpio::Descriptor::connector
 Descripteurs des connecteurs.
 
std::string Sysio::Gpio::Descriptor::name
 Nom de la carte.
 

Function Documentation

Connector* Sysio::Gpio::connector ( int  conn) const

#include <gpio.h>

Connecteur.

Parameters
connnuméro du connecteur, les numéros ne sont pas forcément contiguës, pour parcourir les connecteurs on utilisera les itérateurs de la STL associés à connector(). Déclenche une exception std::out_of_range si en dehors des clous.
Returns
pointeur sur le connecteur
const std::map<int, std::shared_ptr<Connector> >& Sysio::Gpio::connector ( )

#include <gpio.h>

Liste des connecteurs de la carte.

Permet de parcourir les connecteurs à l'aide des itérateurs de la STL, par exemple pour imprimer tous les connecteurs

Gpio * g = new Gpio;
// ....
for (auto p = g->connector().cbegin(); p != g->connector().cend(); ++p) {
// p est une std::pair: first = numéro et second = connecteur
cout << p->second;
}
Returns
Container std::map des connecteurs indexé sur leur numéro
Sysio::Gpio::Gpio ( AccessLayer  layer = AccessLayerAuto)

#include <gpio.h>

Constructeur par défaut.

Parameters
layerchoix de la couche d'accès, AccessLayerAuto par défaut, dans ce cas, le choix est laissé à la couche GpioDevice (conseillé).
Sysio::Gpio::Gpio ( Device *  device,
AccessLayer  layer 
)
explicitprotected

#include <gpio.h>

Constructeur sous jacent.

Doit être appelé par le constucteur par défaut défini dans la partie spécifique à la plateforme.

Parameters
devicepointeur sur le driver de la plateforme
layerchoix de la couche d'accès
Pin::Numbering Sysio::Gpio::numbering ( ) const

#include <gpio.h>

Numérotation en cours.

La numérotation par défaut est NumberingLogical.

bool Sysio::Gpio::open ( )

#include <gpio.h>

Ouverture.

Returns
true si ouvert
Pin& Sysio::Gpio::pin ( int  num) const

#include <gpio.h>

Broche GPIO.

Parameters
numnuméro de broche dans la numérotation numbering(). Déclenche une exception std::out_of_range si la broche n'existe pas
Returns
référence sur la broche
const std::map<int, std::shared_ptr<Pin> >& Sysio::Gpio::pin ( )

#include <gpio.h>

Liste des broches de type GPIO.

Permet de parcourir les broches GPIO à l'aide des itérateurs de la STL, par exemple pour mettre en entrée toutes les broches:

// ....
for (auto p = g->pin().cbegin(); p != g->pin().cend(); ++p) {
// p est une std::pair: first = numéro et second = broche
p->second->setMode(ModeInput);
}
Returns
Container std::map des broches indexé avec la numérotation numbering().
bool Sysio::Gpio::releaseOnClose ( ) const

#include <gpio.h>

Lecture la libération des broches à la fermeture.

Par défaut, l'ensemble des broches utilisées sont libérées à l'appel de close(). Cette fonction permet de lire l'état de cette directive

Returns
true si validé, false sinon
void Sysio::Gpio::setDebug ( bool  enable)

#include <gpio.h>

Active le mode mise au point.

Cela active l'affichage d'informations de mise au point de la couche matérielle (GpioDevice).

void Sysio::Gpio::setReleaseOnClose ( bool  enable)

#include <gpio.h>

Modifie la libération des broches à la fermeture.

Par défaut, l'ensemble des broches utilisées sont libérées à l'appel de close(). Cette fonction permet de modifier ce comportement.

Parameters
enabletrue active la libération, false la désactive.