Raspin Class Reference

Raspberry Pi GPIO register access. More...

#include <cc/Raspin>

Inheritance diagram for Raspin:

Classes
class	Pin
	A single GPIO pin. More...
class	Group
	A group of GPIO pins. More...

Public Types
enum class	Level { Low = 0 , High = 1 }
	GPIO Voltage level. More...
enum class	Mode : uint32_t {   Input = 0 , Output = 1 , Alt0 = 2 , Alt1 = 3 ,   Alt2 = 4 , Alt3 = 5 , Alt4 = 6 , Alt5 = 7 }
	GPIO mode. More...
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.

Public Member Functions
	Raspin ()
	Obtain access to the GPIO registers.
Pin	operator[] (int index)
	Select a single GPIO pin.
Group	select (std::initializer_list< int > pins)
	Select a set of GPIO pins.
template<template< class > class List>
Group	select (List< int > pins)
	Select a set of GPIO pins (convenience method).
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Protected Member Functions inherited from Singleton
	Singleton ()=default
	Create a null singleton.
	Singleton (State *state)
	Initialize singleton object with instance state.
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Singleton
template<class T>
static Handle< T > &	handle ()
template<class T>
static void	destroy ()
template<class T>
static T *	instance ()
	Get access to the singleton instance.
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Raspberry Pi GPIO register access.

Member Enumeration Documentation

Level

enum class Level

strong

GPIO Voltage level.

Mode

enum class Mode : uint32_t

strong

GPIO mode.

Enumerator
Input	Sense input.
Output	Generate output.
Alt0	Alternative function.
Alt1	Alternative function.
Alt2	Alternative function.
Alt3	Alternative function.
Alt4	Alternative function.
Alt5	Alternative function.

Constructor & Destructor Documentation

Raspin()

Raspin

(

)

Obtain access to the GPIO registers.

Member Function Documentation

operator[]()

Raspin::Pin operator[]

(

int

index

)

Select a single GPIO pin.

select() [1/2]

Raspin::Group select

(

std::initializer_list< int >

pins

)

Select a set of GPIO pins.

select() [2/2]

template<template< class > class List>

Group select

(

List< int >

pins

)

Select a set of GPIO pins (convenience method).