tools Namespace Reference

Functions
long	nthNumberFrom (String &in, int num)
	Identifies contiguous series of digits in String, giving you the toInt() of the nth one. More...
void	trim (String &in)
	Takes spaces off start and end of supplied string, operates in place on String passed in. More...
void	shiftInBit (uint8_t *buf, const int len, const bool bit)
	Shifts bits into a range of bytes. Reverse order because length may be unkown at start. More...
bool	shiftOutBit (uint8_t *buf, const int len)
	Shifts out the bits in an array of bytes, emptying array in process. More...
void	split (const String &in, const String &separator, String &before, String &after)
	Will split a srting in two on first occurence of String separator. More...
bool	between (const int &compare, const int &lower_bound, const int &upper_bound)
	See if number is between two bounds. More...

Function Documentation

nthNumberFrom()

long tools::nthNumberFrom	(	String &	in,
		int	num
	)

Identifies contiguous series of digits in String, giving you the toInt() of the nth one.

Parameters

in	(String) The string we're looking at.
num	(int) Which series of numbers you'd like evaluated.

Returns

(long) The toInt() value you wre looking for, or -1 if there weren't that many series of digits.

Definition at line 25 of file tools.cpp.

trim()

void tools::trim

(

String &

in

)

Takes spaces off start and end of supplied string, operates in place on String passed in.

Parameters

in	(String) The string in question, will be modified if need be.

Definition at line 12 of file tools.cpp.

shiftInBit()

void tools::shiftInBit	(	uint8_t *	buf,
		const int	len,
		const bool	bit
	)

Shifts bits into a range of bytes. Reverse order because length may be unkown at start.

Parameters

buf	pointer to uint8_t array with enough space for the bits to me shifted in.
len	number of bits that have been shifted in so far.
bit	bool holding the bit to be shifted in this time

Definition at line 49 of file tools.cpp.

shiftOutBit()

bool tools::shiftOutBit	(	uint8_t *	buf,
		const int	len
	)

Shifts out the bits in an array of bytes, emptying array in process.

Parameters

buf	(uint8_t*) pointer to array, MSB of leftmost byte gets shifted out first.
len	(int) Number of bits in buffer in total.

Returns

(bool) the bit shifted out.

Definition at line 64 of file tools.cpp.

split()

void tools::split	(	const String &	in,
		const String &	separator,
		String &	before,
		String &	after
	)

Will split a srting in two on first occurence of String separator.

Parameters

in	String to be examined
separator	substring to be found
before	Will be set to part before first occurence of separator
after	Will be set to part after first occurence of separator

Definition at line 81 of file tools.cpp.

between()

bool tools::between	(	const int &	compare,
		const int &	lower_bound,
		const int &	upper_bound
	)

See if number is between two bounds.

Parameters

compare	Number to compare
lower_bound	lower bound
upper_bound	upper bound

Returns

true if compare >= lower and <= upper bound

Definition at line 99 of file tools.cpp.