NetBurner 3.1
PinVector< n > Class Template Reference

GPIO Pin Vector Class PinVector is a template instantiation of the _PinVector class, allowing for minimal storage requirements for potentially large vectors, without heavy code duplication due to template copies. More...

#include <cpu_pins.h>

Inherits _PinVector.

Public Member Functions

 PinVector ()
 Bare constructor for a PinVector, where the bit configurations will be made later.
 
 PinVector (PinIO *initpins, uint32_t pinCount)
 PinVector Constructor, where pin configurations will be made at the time of construction. More...
 
uint32_t operator= (uint32_t val)
 Assign a value to the PinVector Bus. More...
 
- Public Member Functions inherited from _PinVector
uint32_t operator= (uint32_t val)
 Assign a value to the _PinVector Bus. More...
 
PinIO operator[] (int idx)
 Access the PinIO for a specific bit position in the _PinVector. More...
 
void config (uint32_t idx, PinIO cfg)
 Set the PinIO that will be used for a given bit position in the _PinVector. More...
 
void config (PinIO *pinCfgs, uint32_t count)
 Configure the _PinVector based on an array of PinIOs. The index of the PinIO in the configuration array will determine the bit position within the _PinVector that that PinIO represents. More...
 
 operator uint32_t () const
 Read the line state of the _PinVector bus. More...
 

Detailed Description

template<uint8_t n>
class PinVector< n >

GPIO Pin Vector Class PinVector is a template instantiation of the _PinVector class, allowing for minimal storage requirements for potentially large vectors, without heavy code duplication due to template copies.

Constructor & Destructor Documentation

◆ PinVector()

template<uint8_t n>
PinVector< n >::PinVector ( PinIO initpins,
uint32_t  pinCount 
)
inline

PinVector Constructor, where pin configurations will be made at the time of construction.

Parameters
initpinsThe array of PinIOs to be used to configure the PinVector.
pinCountThe number of PinIOs in the configuration array to be used.

Member Function Documentation

◆ operator=()

template<uint8_t n>
uint32_t PinVector< n >::operator= ( uint32_t  val)
inline

Assign a value to the PinVector Bus.

Parameters
valThe value to assign to the bus.
Returns
The value driven on the bus.

The documentation for this class was generated from the following file: