blink1_lib::PatternLineN Struct Reference

#include <PatternLineN.hpp>

Collaboration diagram for blink1_lib::PatternLineN:

Public Member Functions
	PatternLineN () noexcept=default
	PatternLineN (const RGBN &_rgbn, const std::uint16_t _fadeMillis) noexcept
	PatternLineN (const std::uint8_t _r, const std::uint8_t _g, const std::uint8_t _b, const std::uint8_t _n, const std::uint16_t _fadeMillis) noexcept
bool	operator== (const PatternLineN &other) const noexcept
bool	operator!= (const PatternLineN &other) const noexcept

Public Attributes
std::uint16_t	fadeMillis {0}
RGBN	rgbn

Friends
std::ostream &	operator<< (std::ostream &os, const PatternLineN &patternLine)

Detailed Description

Same as a PatternLine, but uses RGBN to also store an LED ID

Constructor & Destructor Documentation

PatternLineN() [1/3]

blink1_lib::PatternLineN::PatternLineN ( )

defaultnoexcept

Default constructor

Initializes all values to 0

PatternLineN() [2/3]

blink1_lib::PatternLineN::PatternLineN ( const RGBN &  _rgbn, const std::uint16_t  _fadeMillis  )

noexcept

Parameters

_rgbn	RGBN value
_fadeMillis	Fade time in milliseconds

PatternLineN() [3/3]

blink1_lib::PatternLineN::PatternLineN ( const std::uint8_t  _r, const std::uint8_t  _g, const std::uint8_t  _b, const std::uint8_t  _n, const std::uint16_t  _fadeMillis  )

noexcept

Parameters

_r	Red value
_g	Green value
_b	Blue value
_n	LED index
_fadeMillis	Fade time in milliseconds

Member Function Documentation

operator!=()

bool blink1_lib::PatternLineN::operator!= ( const PatternLineN &  other ) const

noexcept

Inequality operator

Parameters

other

Object to compare to

Returns

true if the objects are not equal, false otherwise

operator==()

bool blink1_lib::PatternLineN::operator== ( const PatternLineN &  other ) const

noexcept

Equality operator

Parameters

other

Object to compare to

Returns

true if the objects are equal, false otherwise

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const PatternLineN &  patternLine  )

friend

Output operator

Parameters

os	Output stream
patternLine	PatternLineN to output

Member Data Documentation

fadeMillis

std::uint16_t blink1_lib::PatternLineN::fadeMillis {0}

Fade time in milliseconds

rgbn

RGBN blink1_lib::PatternLineN::rgbn

RGBN value

---

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

• include/PatternLineN.hpp