Класс PIByteArray представляет собой массив байтов. Подробнее...

#include <pibytearray.h>

Граф наследования:PIByteArray:

Открытые члены
	PIByteArray ()
	Создает пустой байтовый массив

	PIByteArray (const PIByteArray &o)
	Создает копию байтового массива "o".

	PIByteArray (const PIDeque< uchar > &o)
	Создает копию байтового массива "o".

	PIByteArray (const uint size)
	Создает заполненный "0" байтовый массив размером "size".

	PIByteArray (const void *data, const uint size)
	Создает байтовый массив из данных по указателю "data" размером "size".

	PIByteArray (const uint size, uchar t)
	Создает заполненный "t" байтовый массив размером "size".

	PIByteArray (std::initializer_list< uchar > init_list)
	Создает массив из списка инициализации C++11. Подробнее...

void	swap (PIByteArray &other)
	Меняет местами массив `v` с этим массивом. Подробнее...

PIDeque< uchar >::iterator	begin ()
	Итератор на первый элемент. Подробнее...

PIDeque< uchar >::iterator	end ()
	Итератор на элемент, следующий за последним элементом. Подробнее...

PIDeque< uchar >::reverse_iterator	rbegin ()
	Обратный итератор на первый элемент. Подробнее...

PIDeque< uchar >::reverse_iterator	rend ()
	Обратный итератор на элемент, следующий за последним элементом. Подробнее...

size_t	size () const
	Количество элементов массива. Подробнее...

ssize_t	size_s () const
	Количество элементов массива в виде знакового числа. Подробнее...

size_t	length () const
	Синоним size(). Подробнее...

size_t	capacity () const
	Количество элементов, для которого сейчас выделена память массивом. Подробнее...

bool	isEmpty () const
	Проверяет пуст ли массив. Подробнее...

bool	isNotEmpty () const
	Проверяет не пуст ли массив. Подробнее...

bool	any (std::function< bool(uchar e)> test) const
	Проверяет, удовлетворяет ли какой-либо элемент массива условию, заданному в передаваемой функции `test`. Подробнее...

bool	every (std::function< bool(uchar e)> test) const
	Проверяет, удовлетворяют ли все элементы массива условию, заданному в передаваемой функции `test`. Подробнее...

uchar &	operator[] (size_t index)
	Полный доступ к элементу по индексу `index`. Подробнее...

uchar	at (size_t index) const
	Доступ исключительно на чтение к элементу по индексу `index`. Подробнее...

uchar &	back ()
	Последний элемент массива. Подробнее...

uchar &	front ()
	Первый элемент массива. Подробнее...

bool	contains (uchar e, ssize_t start=0) const
	Проверяет наличие элемента `e` в массиве. Подробнее...

int	entries (uchar e, ssize_t start=0) const
	Подсчитывает количество элементов, совпадающих с элементом `e` в массиве. Подробнее...

int	entries (std::function< bool(uchar e)> test, ssize_t start=0) const
	Подсчитывает количество элементов в массиве, проходящих по условию, заданному в передаваемой функции `test`. Подробнее...

ssize_t	indexOf (const uchar &e, ssize_t start=0) const
	Возвращает первый индекс, по которому данный элемент `e` может быть найден в массиве или `-1`, если такого индекса нет. Подробнее...

ssize_t	indexWhere (std::function< bool(const uchar &e)> test, ssize_t start=0) const
	Возвращает первый индекс элемента проходящего по условию, заданному в передаваемой функции `test`, или `-1`, если таких элементов нет. Подробнее...

ssize_t	lastIndexOf (const uchar &e, ssize_t start=-1) const
	Возвращает последний индекс, по которому данный элемент `e` может быть найден в массиве или `-1`, если такого индекса нет. Подробнее...

ssize_t	lastIndexWhere (std::function< bool(const uchar &e)> test, ssize_t start=-1) const
	Возвращает последний индекс элемента проходящего по условию, заданному в передаваемой функции `test`, или `-1`, если таких элементов нет. Подробнее...

uchar *	data (size_t index=0)
	Указатель на память массива Подробнее...

const uchar *	data (size_t index=0) const
	Указатель на память массива только для чтения. Подробнее...

PIByteArray &	clear ()
	Очищает массив, удаляет все элементы. Подробнее...

PIByteArray &	fill (uchar e=0)
	Заполняет весь массив копиями элемента 'e'. Подробнее...

PIByteArray &	fill (std::function< uchar(size_t i)> f)
	Заполняет весь массив результатом вызова функции 'f(size_t i)'. Подробнее...

PIByteArray &	assign (uchar e=0)
	Тоже самое что и fill(). Подробнее...

PIByteArray &	assign (size_t new_size, uchar e)
	Сначала делает `resize(new_size)`, затем `fill(e)`. Подробнее...

PIByteArray &	resize (size_t new_size, uchar e=0)
	Устанавливает размер массива, новые элементы копируются из `e`. Подробнее...

PIByteArray &	resize (size_t new_size, std::function< uchar(size_t i)> f)
	Устанавливает размер массива, новые элементы создаются функцией `f(size_t i)`. Подробнее...

PIByteArray	resized (uint new_size) const
	Возвращает копию байтового массива с измененным размером

PIByteArray &	reserve (size_t new_size)
	Резервируется память под как минимум `new_size` элементов. Подробнее...

PIByteArray &	insert (size_t index, uchar e=0)
	Вставляет значение `e` в позицию `index` в массиве. Подробнее...

PIByteArray &	insert (size_t index, const PIByteArray &v)
	Вставляет массив `v` в позицию `index` в массиве. Подробнее...

PIByteArray &	insert (size_t index, std::initializer_list< uchar > init_list)
	Вставляет элементы в позицию `index` в массиве. Подробнее...

PIByteArray &	remove (size_t index, size_t count=1)
	Удаляет элементы из массива, начиная с позиции `index` в количестве `count`. Подробнее...

PIByteArray	getRange (size_t index, size_t count) const
	Возвращает подмассив с данными от индекса "index" и размером не более "count".

PIByteArray	takeRange (size_t index, size_t count)
	Вырезает подмассив, то есть кусок из текущего массива. Подробнее...

PIByteArray &	reverse ()
	Обращает порядок следования элементов этого массива. Подробнее...

PIByteArray	reversed () const
	Возвращает перевернутый массив. Подробнее...

PIByteArray &	enlarge (ssize_t add_size, uchar e=0)
	Увеличивает или уменьшает размер массива на `add_size` элементов. Подробнее...

PIByteArray &	removeOne (uchar e)
	Удаляет первый элемент, который равен элементу `e`. Подробнее...

PIByteArray &	removeAll (uchar e)
	Удаляет все элементы, равные элементу `e`. Подробнее...

PIByteArray &	removeWhere (std::function< bool(uchar e)> test)
	Удаляет все элементы, удовлетворяющие условию, заданному в передаваемой функции `test`. Подробнее...

PIByteArray &	push_back (uchar e)
	Добавляет элемент `e` в конец массива. Подробнее...

PIByteArray &	push_back (std::initializer_list< uchar > init_list)
	Добавляет элементы в конец массива. Подробнее...

PIByteArray &	push_back (const PIByteArray &v)
	Добавляет массив `v` в конец массива. Подробнее...

PIByteArray &	push_back (const void *data_, int size_)
	Добавляет в конец массива данные по указателю "data" размером "size".

PIByteArray &	push_front (uchar e)
	Добавляет элемент `e` в начало массива. Подробнее...

PIByteArray &	push_front (const PIByteArray &v)
	Добавляет массив `v` в начало массива. Подробнее...

PIByteArray &	push_front (std::initializer_list< uchar > init_list)
	Добавляет элементы в начало массива. Подробнее...

PIByteArray &	prepend (uchar e)
	Добавляет элемент `e` в начало массива. Подробнее...

PIByteArray &	prepend (const PIByteArray &v)
	Добавляет массив `v` в начало массива. Подробнее...

PIByteArray &	prepend (std::initializer_list< uchar > init_list)
	Добавляет элементы в начало массива. Подробнее...

PIByteArray &	pop_back ()
	Удаляет один элемент с конца массива. Подробнее...

PIByteArray &	pop_front ()
	Удаляет один элемент с начала массива. Подробнее...

uchar	take_back ()
	Удаляет один элемент с начала массива и возвращает его. Подробнее...

uchar	take_front ()
	Удаляет один элемент с конца массива и возвращает его. Подробнее...

PIByteArray	filter (std::function< bool(const uchar &e)> test) const
	Возвращает новый массив со всеми элементами, прошедшими проверку, задаваемую в передаваемой функции `test`. Подробнее...

void	forEach (std::function< void(const uchar &e)> f) const
	Выполняет функцию `void f(const uchar & e)` для каждого элемента массива. Подробнее...

PIByteArray &	forEach (std::function< void(uchar &e)> f)
	Выполняет функцию `void f(uchar & e)` для каждого элемента массива. Подробнее...

template<typename ST >
PIDeque< ST >	map (std::function< ST(const uchar &e)> f) const
	Создаёт новый массив с результатом вызова указанной функции `ST f(const T & e)` для каждого элемента массива. Подробнее...

template<typename ST >
ST	reduce (std::function< ST(const uchar &e, const ST &acc)> f, const ST &initial=ST()) const
	Применяет функцию `ST f(const uchar & e, const ST & acc)` к каждому элементу массива (слева-направо), возвращает одно значение. Подробнее...

PIByteArray &	convertToBase64 ()
	Преобразует данные в Base 64 и возвращает текущий массив

PIByteArray &	convertFromBase64 ()
	Преобразует данные из Base 64 и возвращает текущий массив

PIByteArray	toBase64 () const
	Возвращает копию байтового массива, преобразованного в Base 64.

PIString	toString (int base=16) const
	Возвращает текстовое представление байтового массива, каждый байт в "base" системе, с пробелами

PIString	toHex () const
	Возвращает шестнадцатеричное представление массива, без пробелов. Оно использует цифры 0-9 и буквы a-f.

PIByteArray &	append (const void *data_, int size_)
	Добавляет в конец массива данные по указателю "data" размером "size".

PIByteArray &	append (const PIByteArray &data_)
	Добавляет в конец массива содержимое массива "data".

PIByteArray &	append (uchar t)
	Добавляет в конец массива байт "t".

PIByteArray &	append (std::initializer_list< uchar > init_list)
	Добавляет элементы в конец массива. Подробнее...

uchar	checksumPlain8 (bool inverse=true) const
	Возвращает 8-битную контрольную сумму Подробнее...

uint	checksumPlain32 (bool inverse=true) const
	Возвращает 32-битную контрольную сумму Подробнее...

uchar	checksumCRC8 () const
	Возвращает 8-битную контрольную сумму CRC-8.

ushort	checksumCRC16 () const
	Возвращает 16-битную контрольную сумму CRC-16.

uint	checksumCRC32 () const
	Возвращает 32-битную контрольную сумму CRC-32.

uint	hash () const
	Возвращает хэш содержимого

Открытые члены унаследованные от PIBinaryStream< PIByteArray >
bool	binaryStreamAppend (const void *d, size_t s)
	Записать данные

void	binaryStreamAppend (T v)
	Записать данные

bool	binaryStreamTake (void *d, size_t s)
	Прочитать данные

ssize_t	binaryStreamSize () const
	Возвращает оставшийся размер Подробнее...

int	binaryStreamTakeInt ()
	Прочитать int.

bool	wasReadError () const
	Возвращает было ли неполное чтение с момента последнего вызова resetReadError() или создания потока

void	resetReadError ()
	Сбрасывает флаг неполного чтения

Открытые статические члены
static PIByteArray	fromBase64 (const PIByteArray &base64)
	Возвращает массив из Base 64 представления

Относящиеся к классу функции
(не члены класса)
PICout	operator<< (PICout s, const PIBitArray &ba)
	Оператор вывода в PICout.

bool	operator< (const PIByteArray &v0, const PIByteArray &v1)
	Оператор сравнения

bool	operator> (const PIByteArray &v0, const PIByteArray &v1)
	Оператор сравнения

bool	operator== (const PIByteArray &v0, const PIByteArray &v1)
	Оператор сравнения

bool	operator!= (const PIByteArray &v0, const PIByteArray &v1)
	Оператор сравнения

PIByteArray	operator& (const PIByteArray &v0, const PIByteArray &v1)
	Возвращает по-битовое "и" Если размеры не совпадают, возвращает пустой PIByteArray.

PIByteArray	operator\| (const PIByteArray &v0, const PIByteArray &v1)
	Возвращает по-битовое "или" Если размеры не совпадают, возвращает пустой PIByteArray.

PIByteArray	operator^ (const PIByteArray &v0, const PIByteArray &v1)
	Возвращает по-битовое "исключающее или" Если размеры не совпадают, возвращает пустой PIByteArray.

PICout	operator<< (PICout s, const PIByteArray &ba)
	Оператор вывода в PICout.

template<>
uint	piHash (const PIByteArray &ba)
	Возвращает PIByteArray::hash() от "ba".

template<>
void	piSwap (PIByteArray &f, PIByteArray &s)
	Меняет содержимое массивов "f" и "s".

template<typename T >
PIByteArray	piSerialize (const T &value)
	Сохраняет "value" в байтовый массив и возвращает его

template<typename T >
T	piDeserialize (const PIByteArray &data)
	Извлекает тип "T" из байтового массива "data" и возвращает его

Относящиеся к классу функции унаследованные от PIBinaryStream< PIByteArray >
PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PISystemMonitor::ProcessStats &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PISystemMonitor::ThreadStats &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIKbdListener::MouseEvent &v)
	Оператор сохранения

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIKbdListener::WheelEvent &v)
	Оператор сохранения

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIScreenTypes::Cell &v)
	Оператор сохранения

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIScreenTypes::TileEvent &v)
	Оператор сохранения

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIFile::FileInfo &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIPeer::PeerInfo::PeerAddress &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIPeer::PeerInfo &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PISerial::DeviceInfo &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIString &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIStringList &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIByteArray &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIPropertyStorage::Property &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIPropertyStorage &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIValueTree &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariant &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::Enumerator &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::Enum &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::File &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::Dir &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::Color &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator<< (PIBinaryStream< PIByteArray > &s, const PIVariantTypes::IODevice &v)
	Оператор сохранения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PISystemMonitor::ProcessStats &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PISystemMonitor::ThreadStats &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIKbdListener::MouseEvent &v)
	Оператор извлечения

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIKbdListener::WheelEvent &v)
	Оператор извлечения

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIScreenTypes::Cell &v)
	Оператор извлечения

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIScreenTypes::TileEvent &v)
	Оператор извлечения

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIFile::FileInfo &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIPeer::PeerInfo::PeerAddress &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIPeer::PeerInfo &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PISerial::DeviceInfo &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIString &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIStringList &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIByteArray &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIPropertyStorage::Property &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIPropertyStorage &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIValueTree &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariant &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::Enumerator &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::Enum &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::File &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::Dir &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::Color &v)
	Оператор извлечения.

PIBinaryStream< PIByteArray > &	operator>> (PIBinaryStream< PIByteArray > &s, PIVariantTypes::IODevice &v)
	Оператор извлечения.

Подробное описание

Класс PIByteArray представляет собой массив байтов.

PIByteArray используется для хранения байтов. Он может быть сконструирован из любых даных. Можно использовать PIByteArray как потоковый объект для сериализации/десериализации любых типов и данных. Подробнее Поток ввода/вывода. Этот класс использует PIDeque<uchar> и предоставляет набор удобных методов для работы с байтами.

Использование

PIByteArray наследован от PIBinaryStream и может быть использован для сохранения любых данных и работы с ними. Операторы сохранения добавляют данные в конец массива, а операторы извлечения берут данные из его начала. Также есть методы для преобразования в Hex и Base64.

Внимание

Потоковый оператор для типа PIByteArray сохраняет его как контейнер, а не просто добавляет его содержимое в конец. Этот оператор полезен для управляемой упаковки произвольных данных в виде PIByteArray. Для добавления содержимого одного байтового массива к другому используется метод append().

PIByteArray ba, sba;
uchar uc(127);
sba << uc; // byte array with one byte
ba << sba; // stream operator
piCout << ba; // result
// {1, 0, 0, 0, 127}
ba.clear();
ba.append(sba);
piCout << ba; // result
// {127}

Конструктор(ы)

◆ PIByteArray()

PIByteArray::PIByteArray ( std::initializer_list< uchar > init_list )

inline

Создает массив из списка инициализации C++11.

PIByteArray v{1,2,3};

piCout << v; // {1, 2, 3}

Методы

◆ swap()

void PIByteArray::swap ( PIByteArray & other )

inline

Меняет местами массив v с этим массивом.

Эта операция выполняется мгновенно без копирования памяти и никогда не дает сбоев.

◆ begin()

PIDeque< uchar >::iterator PIByteArray::begin ( )

inline

Итератор на первый элемент.

Если массив - пуст, возвращаемый итератор будет равен end().

Возвращает: Итераторы в стиле STL

См. также: end(), rbegin(), rend()

◆ end()

PIDeque< uchar >::iterator PIByteArray::end ( )

inline

Итератор на элемент, следующий за последним элементом.

Этот элемент существует лишь условно, попытка доступа к нему приведёт к выходу за разрешенную память.

Возвращает: Итераторы в стиле STL

См. также: begin(), rbegin(), rend()

◆ rbegin()

PIDeque< uchar >::reverse_iterator PIByteArray::rbegin ( )

inline

Обратный итератор на первый элемент.

Итератор для прохода массива в обратном порядке. Указывает на последний элемент. Если массив пустой, то совпадает с итератором rend().

Возвращает: Итераторы в стиле STL

См. также: rend(), begin(), end()

◆ rend()

PIDeque< uchar >::reverse_iterator PIByteArray::rend ( )

inline

Обратный итератор на элемент, следующий за последним элементом.

Итератор для прохода массива в обратном порядке. Указывает на элемент, предшествующий первому элементу. Этот элемент существует лишь условно, попытка доступа к нему приведёт к выходу за разрешенную память.

Возвращает: Итераторы в стиле STL

См. также: rbegin(), begin(), end()

◆ size()

size_t PIByteArray::size ( ) const

inline

Количество элементов массива.

См. также: size_s(), capacity(), isEmpty(), isNotEmpty(), resize(), reserve()

◆ size_s()

ssize_t PIByteArray::size_s ( ) const

inline

Количество элементов массива в виде знакового числа.

См. также: size(), capacity(), isEmpty(), isNotEmpty(), resize(), reserve()

◆ length()

size_t PIByteArray::length ( ) const

inline

Синоним size().

См. также: size(), size_s(), capacity(), isEmpty(), isNotEmpty(), resize(), reserve()

◆ capacity()

size_t PIByteArray::capacity ( ) const

inline

Количество элементов, для которого сейчас выделена память массивом.

Чтобы узнать фактическое количество элементов используйте функцию size().

См. также: reserve(), size(), size_s()

◆ isEmpty()

bool PIByteArray::isEmpty ( ) const

inline

Проверяет пуст ли массив.

Возвращает: true если массив пуст, false иначе.

См. также: size(), size_s(), isEmpty(), isNotEmpty(), resize(), reserve()

◆ isNotEmpty()

bool PIByteArray::isNotEmpty ( ) const

inline

Проверяет не пуст ли массив.

Возвращает: true если массив не пуст, false иначе.

См. также: size(), size_s(), isEmpty(), isNotEmpty(), resize(), reserve()

◆ any()

bool PIByteArray::any ( std::function< bool(uchar e)> test ) const

inline

Проверяет, удовлетворяет ли какой-либо элемент массива условию, заданному в передаваемой функции test.

Возвращает: true если хотя бы для одного элемента передаваемая функция возвращает true, в остальных случаях false. Метод возвращает false при любом условии для пустого массива.

См. также: every(), contains(), entries(), forEach()

◆ every()

bool PIByteArray::every ( std::function< bool(uchar e)> test ) const

inline

Проверяет, удовлетворяют ли все элементы массива условию, заданному в передаваемой функции test.

Возвращает: true если для всех элементов передаваемая функция возвращает true, в остальных случаях false. Метод возвращает true при любом условии для пустого массива.

См. также: any(), contains(), entries(), forEach()

◆ operator[]()

uchar & PIByteArray::operator[] ( size_t index )

inline

Полный доступ к элементу по индексу index.

Индекс элемента считается от 0. Индекс элемента должен лежать в пределах от 0 до size()-1. Иначе это приведёт к неопределённому поведению программы и ошибкам памяти.

См. также: at()

◆ at()

uchar PIByteArray::at ( size_t index ) const

inline

Доступ исключительно на чтение к элементу по индексу index.

Индекс элемента считается от 0. Индекс элемента должен лежать в пределах от 0 до size()-1. Иначе это приведёт к неопределённому поведению программы и ошибкам памяти.

◆ back()

uchar & PIByteArray::back ( )

inline

Последний элемент массива.

Возвращает ссылку на последний элемент в массиве. Эта функция предполагает, что массив не пустой. Иначе это приведёт к неопределённому поведению программы и ошибкам памяти.

◆ front()

uchar & PIByteArray::front ( )

inline

Первый элемент массива.

Возвращает ссылку на пенрвый элемент в массиве. Эта функция предполагает, что массив не пустой. Иначе это приведёт к неопределённому поведению программы и ошибкам памяти.

◆ contains()

bool PIByteArray::contains	(	uchar	e,
		ssize_t	start = `0`
	)		const

inline

Проверяет наличие элемента e в массиве.

Опциональный аргумент start указывает на индекс в массиве, откуда будет начинаться поиск. Если индекс больше или равен длине массива, возвращается false, что означает, что массив даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Если рассчитанный индекс все равно оказывается меньше 0, просматривается весь массив. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от начала к концу. Значение по умолчанию равно 0, что означает, что просматривается весь массив.

PIByteArray v{1, 2, 3, 4};
piCout << v.contains(3);      // true
piCout << v.contains(5);      // false
piCout << v.contains(3, 3);   // false
piCout << v.contains(3, -2);  // true
piCout << v.contains(3, -99); // true

Возвращает: true если элемент e присутствует в массиве, в остальных случаях false.

См. также: every(), any(), entries()

◆ entries() [1/2]

int PIByteArray::entries	(	uchar	e,
		ssize_t	start = `0`
	)		const

inline

Подсчитывает количество элементов, совпадающих с элементом e в массиве.

Опциональный аргумент start указывает на индекс в массиве, откуда будет начинаться поиск. Если индекс больше или равен длине массива, возвращается 0, что означает, что массив даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Если рассчитанный индекс все равно оказывается меньше 0, просматривается весь массив. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от начала к концу. Значение по умолчанию равно 0, что означает, что просматривается весь массив.

См. также: every(), any(), contains(), indexOf()

◆ entries() [2/2]

int PIByteArray::entries	(	std::function< bool(uchar e)>	test,
		ssize_t	start = `0`
	)		const

inline

Подсчитывает количество элементов в массиве, проходящих по условию, заданному в передаваемой функции test.

Перегруженная функция. Опциональный аргумент start указывает на индекс в массиве, откуда будет начинаться поиск. Если индекс больше или равен длине массива, возвращается 0, что означает, что массив даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Если рассчитанный индекс все равно оказывается меньше 0, просматривается весь массив. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от начала к концу. Значение по умолчанию равно 0, что означает, что просматривается весь массив.

См. также: every(), any(), contains(), indexWhere()

◆ indexOf()

ssize_t PIByteArray::indexOf	(	const uchar &	e,
		ssize_t	start = `0`
	)		const

inline

Возвращает первый индекс, по которому данный элемент e может быть найден в массиве или -1, если такого индекса нет.

Опциональный аргумент start указывает на индекс в массиве, откуда будет начинаться поиск. Если индекс больше или равен длине массива, возвращается -1, что означает, что массив даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Если рассчитанный индекс все равно оказывается меньше 0, просматривается весь массив. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от начала к концу. Значение по умолчанию равно 0, что означает, что просматривается весь массив.

PIByteArray v{2, 5, 9};
piCout << v.indexOf(2);     // 0
piCout << v.indexOf(7);     // -1
piCout << v.indexOf(9, 2);  // 2
piCout << v.indexOf(2, -1); // -1
piCout << v.indexOf(2, -3); // 0

См. также: indexWhere(), lastIndexOf(), lastIndexWhere(), contains()

◆ indexWhere()

ssize_t PIByteArray::indexWhere	(	std::function< bool(const uchar &e)>	test,
		ssize_t	start = `0`
	)		const

inline

Возвращает первый индекс элемента проходящего по условию, заданному в передаваемой функции test, или -1, если таких элементов нет.

Опциональный аргумент start указывает на индекс в массиве, откуда будет начинаться поиск. Если индекс больше или равен длине массива, возвращается -1, что означает, что массив даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Если рассчитанный индекс все равно оказывается меньше 0, просматривается весь массив. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от начала к концу. Значение по умолчанию равно 0, что означает, что просматривается весь массив.

PIByteArray v{2, 5, 9};
piCout << v.indexWhere([](const uchar & s){return s > 3;});    // 1
piCout << v.indexWhere([](const uchar & s){return s > 3;}, 2); // 2
piCout << v.indexWhere([](const uchar & s){return s > 10;});   // -1

См. также: indexOf(), lastIndexOf(), lastIndexWhere(), contains()

◆ lastIndexOf()

ssize_t PIByteArray::lastIndexOf	(	const uchar &	e,
		ssize_t	start = `-1`
	)		const

inline

Возвращает последний индекс, по которому данный элемент e может быть найден в массиве или -1, если такого индекса нет.

Опциональный аргумент start указывает на индекс c которого начинать поиск в обратном направлении. Если индекс больше или равен длине массива, просматривается весь массив. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от конца к началу. Если рассчитанный индекс оказывается меньше 0, массив даже не просматривается. Значение по умолчанию равно -1, что равно индексу последнего элемента и означает, что просматривается весь массив.

PIByteArray v{2, 5, 9, 2};
piCout << v.lastIndexOf(2);       // 3
piCout << v.lastIndexOf(7);       // -1
piCout << v.lastIndexOf(2, 2);    // 0
piCout << v.lastIndexOf(2, -3);   // 0
piCout << v.lastIndexOf(2, -300); // -1
piCout << v.lastIndexOf(2, 300);  // 3

См. также: indexOf(), indexWhere(), lastIndexWhere(), contains()

◆ lastIndexWhere()

ssize_t PIByteArray::lastIndexWhere	(	std::function< bool(const uchar &e)>	test,
		ssize_t	start = `-1`
	)		const

inline

Возвращает последний индекс элемента проходящего по условию, заданному в передаваемой функции test, или -1, если таких элементов нет.

Опциональный аргумент start указывает на индекс c которого начинать поиск в обратном направлении. Если индекс больше или равен длине массива, просматривается весь массив. Если индекс является отрицательным числом, он трактуется как смещение с конца массива. Обратите внимание: если индекс отрицателен, массив всё равно просматривается от конца к началу. Если рассчитанный индекс оказывается меньше 0, массив даже не просматривается. Значение по умолчанию равно -1, что равно индексу последнего элемента и означает, что просматривается весь массив.

См. также: indexOf(), lastIndexOf(), indexWhere(), contains()

◆ data() [1/2]

uchar * PIByteArray::data ( size_t index = 0 )

inline

Указатель на память массива

Опциональный аргумент index указывает на индекс c которого брать указатель. По умолчанию указывает на начало массива.

◆ data() [2/2]

const uchar * PIByteArray::data ( size_t index = 0 ) const

inline

Указатель на память массива только для чтения.

Указатель можно использовать для доступа и изменения элементов в массиве. Указатель остается действительным только до тех пор, пока массив не будет перераспределен. Опциональный аргумент index указывает на индекс c которого брать указатель. По умолчанию указывает на начало массива.

◆ clear()

PIByteArray & PIByteArray::clear ( )

inline

Очищает массив, удаляет все элементы.

Заметки: Зарезервированная память не освободится.

См. также: resize()

◆ fill() [1/2]

PIByteArray & PIByteArray::fill ( uchar e = 0 )

inline

Заполняет весь массив копиями элемента 'e'.

См. также: resize()

◆ fill() [2/2]

PIByteArray & PIByteArray::fill ( std::function< uchar(size_t i)> f )

inline

Заполняет весь массив результатом вызова функции 'f(size_t i)'.

См. также: resize()

◆ assign() [1/2]

PIByteArray & PIByteArray::assign ( uchar e = 0 )

inline

Тоже самое что и fill().

См. также: fill(), resize()

◆ assign() [2/2]

PIByteArray & PIByteArray::assign	(	size_t	new_size,
		uchar	e
	)

inline

Сначала делает resize(new_size), затем fill(e).

См. также: fill(), resize()

◆ resize() [1/2]

PIByteArray & PIByteArray::resize	(	size_t	new_size,
		uchar	e = `0`
	)

inline

Устанавливает размер массива, новые элементы копируются из e.

Если new_size больше чем текущий размер массива size(), новые элементы добавляются в конец массива и создаются из e. Если new_size меньше чем текущий размер массива size(), лишние элементы удаляются с конца массива.

См. также: size(), clear()

◆ resize() [2/2]

PIByteArray & PIByteArray::resize	(	size_t	new_size,
		std::function< uchar(size_t i)>	f
	)

inline

Устанавливает размер массива, новые элементы создаются функцией f(size_t i).

Если new_size больше чем текущий размер массива size(), новые элементы добавляются в конец массива и функцией f(size_t i). Если new_size меньше чем текущий размер массива size(), лишние элементы удаляются с конца массива.

См. также: size(), clear()

◆ reserve()

PIByteArray & PIByteArray::reserve ( size_t new_size )

inline

Резервируется память под как минимум new_size элементов.

Если вы заранее знаете, насколько велик будет массив, вы можете вызвать эту функцию, чтобы предотвратить перераспределение и фрагментацию памяти. Если размер new_size больше чем выделенная память capacity(), то произойдёт выделение новой памяти и перераспределение массива. Эта функция не изменяет количество элементов в массиве size().

См. также: size(), capacity(), resize()

◆ insert() [1/3]

PIByteArray & PIByteArray::insert	(	size_t	index,
		uchar	e = `0`
	)

inline

Вставляет значение e в позицию index в массиве.

Индекс должен быть больше 0 и меньше или равен size().

См. также: append(), prepend(), remove()

◆ insert() [2/3]

PIByteArray & PIByteArray::insert	(	size_t	index,
		const PIByteArray &	v
	)

inline

Вставляет массив v в позицию index в массиве.

Индекс должен быть больше или равен 0 и меньше или равен size().

См. также: append(), prepend(), remove()

◆ insert() [3/3]

PIByteArray & PIByteArray::insert	(	size_t	index,
		std::initializer_list< uchar >	init_list
	)

inline

Вставляет элементы в позицию index в массиве.

Индекс должен быть больше или равен 0 и меньше или равен size(). Вставляет элементы из списка инициализации C++11.

См. также: append(), prepend(), remove()

◆ remove()

PIByteArray & PIByteArray::remove	(	size_t	index,
		size_t	count = `1`
	)

inline

Удаляет элементы из массива, начиная с позиции index в количестве count.

См. также: resize(), insert(), removeOne(), removeAll(), removeWhere()

◆ takeRange()

PIByteArray PIByteArray::takeRange	(	size_t	index,
		size_t	count
	)

inline

Вырезает подмассив, то есть кусок из текущего массива.

Аргументы

index	- индекс в текущем массиве, откуда начинётся подмассив
count	- размер подмассива

Индекс начала должен лежать в диапазоне от 0 до size()-1. Если заданный размер подмассива превышает размер текущего массива, то вернется подмассив меньшего размера (size()-index-1).

◆ reverse()

PIByteArray & PIByteArray::reverse ( )

inline

Обращает порядок следования элементов этого массива.

Метод reverse() на месте переставляет элементы массива, на котором он был вызван, изменяет массив и возвращает ссылку на него. Первый элемент массива становится последним, а последний — первым.

См. также: reversed()

◆ reversed()

PIByteArray PIByteArray::reversed ( ) const

inline

Возвращает перевернутый массив.

Возвращает копию массива с элементами в обратном порядке. Первый элемент массива становится последним, а последний — первым.

См. также: reverse()

◆ enlarge()

PIByteArray & PIByteArray::enlarge	(	ssize_t	add_size,
		uchar	e = `0`
	)

inline

Увеличивает или уменьшает размер массива на add_size элементов.

Если add_size > 0, то в конец массива добавляются элементы. Если add_size < 0, то с конца массива удаляются элементы. Если add_size < 0 и в массиве меньше элементов чем указано, то массив становится пустым.

См. также: resize()

◆ removeOne()

PIByteArray & PIByteArray::removeOne ( uchar e )

inline

Удаляет первый элемент, который равен элементу e.

См. также: remove(), removeAll(), removeWhere()

◆ removeAll()

PIByteArray & PIByteArray::removeAll ( uchar e )

inline

Удаляет все элементы, равные элементу e.

См. также: remove(), removeOne(), removeWhere()

◆ removeWhere()

PIByteArray & PIByteArray::removeWhere ( std::function< bool(uchar e)> test )

inline

Удаляет все элементы, удовлетворяющие условию, заданному в передаваемой функции test.

См. также: remove(), removeOne(), removeWhere()

◆ push_back() [1/3]

PIByteArray & PIByteArray::push_back ( uchar e )

inline

Добавляет элемент e в конец массива.

Если size() меньше capacity(), что часто бывает, то добавление будет очень быстрым. В любом случае добавление быстрое и не зависит от размера массива. Если новый size() больше, чем capacity(), то все итераторы и указатели становятся нерабочими. В противном случае все, кроме итераторов, указывающих на конец массива, остаются в рабочем состоянии.

См. также: push_front(), append(), prepend(), insert()

◆ push_back() [2/3]

PIByteArray & PIByteArray::push_back ( std::initializer_list< uchar > init_list )

inline

Добавляет элементы в конец массива.

Перегруженая функция. Добавляет элементы из списка инициализации C++11.

См. также: push_back()

◆ push_back() [3/3]

PIByteArray & PIByteArray::push_back ( const PIByteArray & v )

inline

Добавляет массив v в конец массива.

Перегруженая функция.

См. также: push_back()

◆ push_front() [1/3]

PIByteArray & PIByteArray::push_front ( uchar e )

inline

Добавляет элемент e в начало массива.

Если в начале массива имеется свободное место, что часто бывает, то добавление будет очень быстрым. В любом случае добавление быстрое и не зависит от размера массива. Если в начале массива нет свободного места, то все итераторы и указатели становятся нерабочими. В противном случае все, кроме итераторов указывающих, на начало массива, остаются в рабочем состоянии.

См. также: push_back(), append(), prepend(), insert()

◆ push_front() [2/3]

PIByteArray & PIByteArray::push_front ( const PIByteArray & v )

inline

Добавляет массив v в начало массива.

Перегруженая функция.

См. также: push_front()

◆ push_front() [3/3]

PIByteArray & PIByteArray::push_front ( std::initializer_list< uchar > init_list )

inline

Добавляет элементы в начало массива.

Перегруженая функция. Добавляет элементы из списка инициализации C++11.

См. также: append()

◆ prepend() [1/3]

PIByteArray & PIByteArray::prepend ( uchar e )

inline

Добавляет элемент e в начало массива.

Если в начале массива имеется свободное место, что часто бывает, то добавление будет очень быстрым. В любом случае добавление быстрое и не зависит от размера массива. Если в начале массива нет свободного места, то все итераторы и указатели становятся нерабочими. В противном случае все, кроме итераторов указывающих, на начало массива, остаются в рабочем состоянии.

См. также: push_back(), append(), prepend(), insert()

◆ prepend() [2/3]

PIByteArray & PIByteArray::prepend ( const PIByteArray & v )

inline

Добавляет массив v в начало массива.

Перегруженая функция.

См. также: prepend()

◆ prepend() [3/3]

PIByteArray & PIByteArray::prepend ( std::initializer_list< uchar > init_list )

inline

Добавляет элементы в начало массива.

Перегруженая функция. Добавляет элементы из списка инициализации C++11.

См. также: append()

◆ pop_back()

PIByteArray & PIByteArray::pop_back ( )

inline

Удаляет один элемент с конца массива.

Удаление элемента с конца выполняется очень быстро и не зависит от размера массива.

См. также: pop_front(), take_back(), take_front()

◆ pop_front()

PIByteArray & PIByteArray::pop_front ( )

inline

Удаляет один элемент с начала массива.

Удаление элемента с начала выполняется дольше, чем с конца. Это время прямопропорционально размеру массива. При удалении элемента все итераторы и указатели становятся нерабочими.

См. также: pop_back(), take_back(), take_front()

◆ take_back()

uchar PIByteArray::take_back ( )

inline

Удаляет один элемент с начала массива и возвращает его.

См. также: take_front(), pop_back(), pop_front()

◆ take_front()

uchar PIByteArray::take_front ( )

inline

Удаляет один элемент с конца массива и возвращает его.

См. также: take_front(), pop_back(), pop_front()

◆ filter()

PIByteArray PIByteArray::filter ( std::function< bool(const uchar &e)> test ) const

inline

Возвращает новый массив со всеми элементами, прошедшими проверку, задаваемую в передаваемой функции test.

PIByteArray v{3, 2, 5, 2, 7};
PIByteArray v2 = v.filter([](const uchar & i){return i > 2;});
piCout << v2; // {3, 5, 7}

См. также: map(), any(), every()

◆ forEach() [1/2]

void PIByteArray::forEach ( std::function< void(const uchar &e)> f ) const

inline

Выполняет функцию void f(const uchar & e) для каждого элемента массива.

Не позволяет изменять элементы массива. Для редактирования элементов используйте функцию вида void f(uchar & e).

PIByteArray v{1, 2, 3, 4, 5};
int s = 0;
v.forEach([&s](const uchar & e){s += e;});
piCout << s; // 15

См. также: filter(), map(), reduce(), any(), every()

◆ forEach() [2/2]

PIByteArray & PIByteArray::forEach ( std::function< void(uchar &e)> f )

inline

Выполняет функцию void f(uchar & e) для каждого элемента массива.

Перегруженая функция. Позволяет изменять элементы массива.

PIByteArray v{1, 2, 3, 4, 5};
v.forEach([](uchar & e){e++;});
piCout << v; // {2, 3, 4, 5, 6}

См. также: filter(), map(), reduce(), any(), every()

◆ map()

template<typename ST >

PIDeque< ST > PIByteArray::map ( std::function< ST(const uchar &e)> f ) const

inline

Создаёт новый массив с результатом вызова указанной функции ST f(const T & e) для каждого элемента массива.

Метод map вызывает переданную функцию ST f(const uchar & e) один раз для каждого элемента в порядке их появления и конструирует новый массив из результатов её вызова.

PIByteArray v{0x31, 0x0A, 0xFF};
PIStringList sl = v.map<PIString>([](const uchar & i){return PIString::fromNumber(i, 16);});
piCout << sl; {"31", "A", "FF"}

См. также: forEach(), reduce()

◆ reduce()

template<typename ST >

ST PIByteArray::reduce	(	std::function< ST(const uchar &e, const ST &acc)>	f,
		const ST &	initial = `ST()`
	)		const

inline

Применяет функцию ST f(const uchar & e, const ST & acc) к каждому элементу массива (слева-направо), возвращает одно значение.

Метод reduce() выполняет функцию f один раз для каждого элемента, присутствующего в массиве. Если при вызове reduce() передан аргумент initial, то при первом вызове функции f значение acc будет равным значению initial. Если массив пустой то будет возвращено значение initial.

Аргументы

f

Функция, вида ST f(const uchar & e, const ST & acc), выполняющаяся для каждого элемента массива. Она принимает два аргумента:

e - текущий элемент массива
acc - аккумулятор, аккумулирующий значение которое возвращает эта функция после посещения очередного элемента

initial опциональный Объект, используемый в качестве второго аргумента при первом вызове функции f.

PIByteArray v{1, 2, 3, 4, 5};
PIString s = v.reduce<PIString>([](const uchar & e, const PIString & acc){return acc + PIString::fromNumber(e);});
piCout << s; // "12345"

См. также: forEach(), map()

◆ append()

PIByteArray & PIByteArray::append ( std::initializer_list< uchar > init_list )

inline

Добавляет элементы в конец массива.

Перегруженая функция. Добавляет элементы из списка инициализации C++11.

См. также: push_back()

◆ checksumPlain8()

uchar PIByteArray::checksumPlain8 ( bool inverse = true ) const

Возвращает 8-битную контрольную сумму

Это простая сумма всех байтов, если "inverse", то ещё добавляется 1 и инвертируется результат. Псевдокод:

for (i)
    sum += at(i);
if (inverse) return ~(sum + 1);
else return sum;

◆ checksumPlain32()

uint PIByteArray::checksumPlain32 ( bool inverse = true ) const

Возвращает 32-битную контрольную сумму

Это простая сумма всех байтов, умноженных на индекс+1, если "inverse", то ещё добавляется 1 и инвертируется результат. Псевдокод:

for (i)
    sum += at(i) * (i + 1);
if (inverse) return ~(sum + 1);
else return sum;

Открытые члены

Открытые статические члены

Относящиеся к классу функции

Подробное описание

Использование

Внимание

Конструктор(ы)

◆ PIByteArray()

Методы

◆ swap()

◆ begin()

◆ end()

◆ rbegin()

◆ rend()

◆ size()

◆ size_s()

◆ length()

◆ capacity()

◆ isEmpty()

◆ isNotEmpty()

◆ any()

◆ every()

◆ operator[]()

◆ at()

◆ back()

◆ front()

◆ contains()

◆ entries() [1/2]

◆ entries() [2/2]

◆ indexOf()

◆ indexWhere()

◆ lastIndexOf()

◆ lastIndexWhere()

◆ data() [1/2]

◆ data() [2/2]

◆ clear()

◆ fill() [1/2]

◆ fill() [2/2]

◆ assign() [1/2]

◆ assign() [2/2]

◆ resize() [1/2]

◆ resize() [2/2]

◆ reserve()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ remove()

◆ takeRange()

◆ reverse()

◆ reversed()

◆ enlarge()

◆ removeOne()

◆ removeAll()

◆ removeWhere()

◆ push_back() [1/3]

◆ push_back() [2/3]

◆ push_back() [3/3]

◆ push_front() [1/3]

◆ push_front() [2/3]

◆ push_front() [3/3]

◆ prepend() [1/3]

◆ prepend() [2/3]

◆ prepend() [3/3]

◆ pop_back()

◆ pop_front()

◆ take_back()

◆ take_front()

◆ filter()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ map()

◆ reduce()

◆ append()

◆ checksumPlain8()

◆ checksumPlain32()