diff --git a/annotated.html b/annotated.html new file mode 100644 index 000000000..20235a1b7 --- /dev/null +++ b/annotated.html @@ -0,0 +1,87 @@ + + +
+ + + + +
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
▼Nstdex | |
▼Nidrec | |
Crecord | Helper class for read/write of records to/from memory |
Cbase64_dec | Base64 decoding session |
Cbase64_enc | Base64 encoding session |
Chex_dec | Hexadecimal decoding session |
Chex_enc | Hexadecimal encoding session |
Cvector_queue | Helper class to allow limited size FIFO queues implemented as vector of elements |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::base64_dec, including all inherited members.
+base64_dec() noexcept | stdex::base64_dec | inline |
buf | stdex::base64_dec | protected |
clear() noexcept | stdex::base64_dec | inline |
dec_size(size_t size) const noexcept | stdex::base64_dec | inline |
decode(std::vector< _Ty, _Ax > &out, bool &is_last, const _Tchr *data, size_t size) | stdex::base64_dec | inline |
decode(std::vector< _Ty, _Ax > &out) | stdex::base64_dec | inlineprotected |
num | stdex::base64_dec | protected |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Base64 decoding session. + More...
++Public Member Functions | |
+ | base64_dec () noexcept |
Constructs blank decoding session. | |
template<class _Ty , class _Ax , class _Tchr > | |
void | decode (std::vector< _Ty, _Ax > &out, bool &is_last, const _Tchr *data, size_t size) |
Decodes one block of information, and appends it to the output. More... | |
+void | clear () noexcept |
Resets decoding session. | |
size_t | dec_size (size_t size) const noexcept |
Returns maximum decoded size. More... | |
+Protected Member Functions | |
+template<class _Ty , class _Ax > | |
size_t | decode (std::vector< _Ty, _Ax > &out) |
Decodes one complete internal buffer of data. | |
+Protected Attributes | |
+unsigned char | buf [4] |
Internal buffer. | |
+size_t | num |
Number of bytes used in buf | |
Base64 decoding session.
+
+
|
+ +inlinenoexcept | +
Returns maximum decoded size.
+size | Number of bytes to decode |
size
length
+
|
+ +inline | +
Decodes one block of information, and appends it to the output.
+[out] | out | Output |
[in] | is_last | Was this the last block of data? |
[in] | data | Data to decode |
[in] | size | Length of data in bytes |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::base64_enc, including all inherited members.
+base64_enc() noexcept | stdex::base64_enc | inline |
buf | stdex::base64_enc | protected |
clear() noexcept | stdex::base64_enc | inline |
enc_size(size_t size) const noexcept | stdex::base64_enc | inline |
encode(std::basic_string< _Elem, _Traits, _Ax > &out, const void *data, size_t size, bool is_last=true) | stdex::base64_enc | inline |
encode(std::basic_string< _Elem, _Traits, _Ax > &out) | stdex::base64_enc | inlineprotected |
encode(std::basic_string< _Elem, _Traits, _Ax > &out, size_t size) | stdex::base64_enc | inlineprotected |
num | stdex::base64_enc | protected |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Base64 encoding session. + More...
++Public Member Functions | |
+ | base64_enc () noexcept |
Constructs blank encoding session. | |
template<class _Elem , class _Traits , class _Ax > | |
void | encode (std::basic_string< _Elem, _Traits, _Ax > &out, const void *data, size_t size, bool is_last=true) |
Encodes one block of information, and appends it to the output. More... | |
+void | clear () noexcept |
Resets encoding session. | |
size_t | enc_size (size_t size) const noexcept |
Returns maximum encoded size. More... | |
+Protected Attributes | |
+unsigned char | buf [3] |
Internal buffer. | |
+size_t | num |
Number of bytes used in buf | |
Base64 encoding session.
+
+
|
+ +inlinenoexcept | +
Returns maximum encoded size.
+size | Number of bytes to encode |
size
length
+
|
+ +inline | +
Encodes one block of information, and appends it to the output.
+[out] | out | Output |
[in] | data | Data to encode |
[in] | size | Length of data in bytes |
[in] | is_last | Is this the last block of data? |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::hex_dec, including all inherited members.
+buf | stdex::hex_dec | protected |
clear() noexcept | stdex::hex_dec | inline |
dec_size(size_t size) const noexcept | stdex::hex_dec | inline |
decode(std::vector< _Ty, _Ax > &out, bool &is_last, const _Tchr *data, size_t size) | stdex::hex_dec | inline |
hex_dec() noexcept | stdex::hex_dec | inline |
num | stdex::hex_dec | protected |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Hexadecimal decoding session. + More...
++Public Member Functions | |
+ | hex_dec () noexcept |
Constructs blank decoding session. | |
template<class _Ty , class _Ax , class _Tchr > | |
void | decode (std::vector< _Ty, _Ax > &out, bool &is_last, const _Tchr *data, size_t size) |
Decodes one block of information, and appends it to the output. More... | |
+void | clear () noexcept |
Resets decoding session. | |
size_t | dec_size (size_t size) const noexcept |
Returns maximum decoded size. More... | |
+Protected Attributes | |
+unsigned char | buf |
Internal buffer. | |
+size_t | num |
Number of nibbles used in buf | |
Hexadecimal decoding session.
+
+
|
+ +inlinenoexcept | +
Returns maximum decoded size.
+size | Number of bytes to decode |
size
length
+
|
+ +inline | +
Decodes one block of information, and appends it to the output.
+[in,out] | out | Output |
[out] | is_last | Was this the last block of data? Actually, is this block of data complete? |
[in] | data | Data to decode |
[in] | size | Length of data in bytes |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::hex_enc, including all inherited members.
+enc_size(size_t size) const noexcept | stdex::hex_enc | inline |
encode(std::basic_string< _Elem, _Traits, _Ax > &out, const void *data, size_t size) | stdex::hex_enc | inline |
hex_enc() noexcept | stdex::hex_enc | inline |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Hexadecimal encoding session. + More...
++Public Member Functions | |
+ | hex_enc () noexcept |
Constructs blank encoding session. | |
template<class _Elem , class _Traits , class _Ax > | |
void | encode (std::basic_string< _Elem, _Traits, _Ax > &out, const void *data, size_t size) |
Encodes one block of information, and appends it to the output. More... | |
size_t | enc_size (size_t size) const noexcept |
Returns maximum encoded size. More... | |
Hexadecimal encoding session.
+
+
|
+ +inlinenoexcept | +
Returns maximum encoded size.
+size | Number of bytes to encode |
size
length
+
|
+ +inline | +
Encodes one block of information, and appends it to the output.
+[out] | out | Output |
[in] | data | Data to encode |
[in] | size | Length of data in bytes |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::idrec::record< T, T_ID, T_SIZE, ALIGN >, including all inherited members.
+close(std::ostream &stream, std::streamoff start) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inlinestatic |
data | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | |
find(std::istream &stream, std::streamoff end=(std::streamoff) -1) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inlinestatic |
id | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | static |
open(std::ostream &stream) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inlinestatic |
operator=(const record< T, T_ID, T_SIZE, ALIGN > &r) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inline |
record(T &d) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inline |
record(const T &d) | stdex::idrec::record< T, T_ID, T_SIZE, ALIGN > | inline |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Helper class for read/write of records to/from memory. + More...
++Public Member Functions | |
record (T &d) | |
Constructs the class. More... | |
record (const T &d) | |
Constructs the class. More... | |
const record< T, T_ID, T_SIZE, ALIGN > & | operator= (const record< T, T_ID, T_SIZE, ALIGN > &r) |
Assignment operator. More... | |
+Static Public Member Functions | |
static std::streamoff | open (std::ostream &stream) |
Writes record header. More... | |
static std::streamoff | close (std::ostream &stream, std::streamoff start) |
Updates record header. More... | |
static bool | find (std::istream &stream, std::streamoff end=(std::streamoff) -1) |
Finds record data. More... | |
+Public Attributes | |
+T & | data |
Record data reference. | |
+Static Public Attributes | |
+static const T_ID | id |
Record id. | |
Helper class for read/write of records to/from memory.
+
+
|
+ +inline | +
Constructs the class.
+[in] | d | Reference to record data |
+
|
+ +inline | +
Constructs the class.
+[in] | d | Reference to record data |
+
|
+ +inlinestatic | +
Updates record header.
+[in] | stream | Output stream |
[in] | start | Start position of the record in stream |
stream
+
|
+ +inlinestatic | +
Finds record data.
+[in] | stream | Input stream |
[in] | end | Position limit. Default is -1 (no limit). |
true
when foundfalse
otherwise
+
|
+ +inlinestatic | +
Writes record header.
+[in] | stream | Output stream |
stream
. Save for later close
call.
+
|
+ +inline | +
Assignment operator.
+[in] | r | Source record |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
This is the complete list of members for stdex::vector_queue< T >, including all inherited members.
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
Helper class to allow limited size FIFO queues implemented as vector of elements. + More...
++Public Member Functions | |
vector_queue (size_type size_max) | |
Construct queue of fixed size. More... | |
vector_queue (const vector_queue< value_type > &other) | |
Copies existing queue. More... | |
+virtual | ~vector_queue () |
Destroys the queue. | |
vector_queue (vector_queue< value_type > &&other) | |
Moves existing queue. More... | |
vector_queue< value_type > & | operator= (const vector_queue< value_type > &other) |
Copies existing queue. More... | |
vector_queue< value_type > & | operator= (vector_queue< value_type > &&other) |
Moves existing queue. More... | |
+size_type | size () const |
Returns the number of elements in the vector. | |
+size_type | capacity () const |
Returns the number of elements that the queue can contain before overwriting head ones. | |
+void | clear () |
Erases the elements of the queue. | |
+bool | empty () const |
Tests if the queue is empty. | |
reference | at (size_type pos) |
Returns a reference to the element at a specified location in the queue. More... | |
reference | operator[] (size_type pos) |
Returns a reference to the element at a specified location in the queue. More... | |
const_reference | at (size_type pos) const |
Returns a constant reference to the element at a specified location in the queue. More... | |
const_reference | operator[] (size_type pos) const |
Returns a constant reference to the element at a specified location in the queue. More... | |
reference | at_abs (size_type pos) |
Returns a reference to the element at the absolute location in the queue. More... | |
const_reference | at_abs (size_type pos) const |
Returns a constant reference to the element at the absolute location in the queue: measured from the beginning of the storage. More... | |
size_type | push_back (const value_type &v) |
Copies an existing element to the end of the queue, overriding the first one when queue is out of space. More... | |
size_type | push_back (value_type &&v) |
Moves the element to the end of the queue, overriding the first one when queue is out of space. More... | |
+void | pop_back () |
Removes (dequeues) the last element of the queue. | |
size_type | push_front (const value_type &v) |
Copies an existing element to the head of the queue, overriding the last one when queue is out of space and moving all others one place right. More... | |
size_type | push_front (value_type &&v) |
Moves the element to the head of the queue, overriding the last one when queue is out of space and moving all others one place right. More... | |
+void | pop_front () |
Removes (dequeues) the head element of the queue. | |
+reference | front () |
Returns a reference to the head element in the queue. | |
+const_reference | front () const |
Returns a constant reference to the head element in the queue. | |
+reference | back () |
Returns a reference to the last element in the queue. | |
+const_reference | back () const |
Returns a constant reference to the last element in the queue. | |
+size_type | head () const |
Returns absolute subscript or position number of the head element in the queue. The element does not need to exist. | |
+size_type | tail () const |
Returns absolute subscript or position number of the last element in the queue. The element must exist. | |
+size_type | abs (size_type pos) const |
Returns absolute subscript or position number of the given element in the queue. | |
+Protected Attributes | |
+value_type * | m_data |
Underlying data container. | |
+size_type | m_head |
Index of the first element. | |
+size_type | m_count |
Number of elements. | |
+size_type | m_size_max |
Maximum size. | |
Helper class to allow limited size FIFO queues implemented as vector of elements.
+
+
|
+ +inline | +
Construct queue of fixed size.
+[in] | size_max | Maximum number of elements. Please note this cannot be changed later. |
+
|
+ +inline | +
Copies existing queue.
+[in] | other | Queue to copy from |
+
|
+ +inline | +
Moves existing queue.
+[in,out] | other | Queue to move |
+
|
+ +inline | +
Returns a reference to the element at a specified location in the queue.
+[in] | pos | The subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Returns a constant reference to the element at a specified location in the queue.
+[in] | pos | The subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Returns a reference to the element at the absolute location in the queue.
+[in] | pos | The absolute subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Returns a constant reference to the element at the absolute location in the queue: measured from the beginning of the storage.
+[in] | pos | The absolute subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Copies existing queue.
+[in] | other | Queue to copy from |
+
|
+ +inline | +
Moves existing queue.
+[in,out] | other | Queue to move |
+
|
+ +inline | +
Returns a reference to the element at a specified location in the queue.
+[in] | pos | The subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Returns a constant reference to the element at a specified location in the queue.
+[in] | pos | The subscript or position number of the element to reference in the queue. |
+
|
+ +inline | +
Copies an existing element to the end of the queue, overriding the first one when queue is out of space.
+[in] | v | Element to copy to the end of the queue. |
+
|
+ +inline | +
Moves the element to the end of the queue, overriding the first one when queue is out of space.
+[in] | v | Element to move to the end of the queue. |
+
|
+ +inline | +
Copies an existing element to the head of the queue, overriding the last one when queue is out of space and moving all others one place right.
+[in] | v | Element to copy to the head of the queue. |
+
|
+ +inline | +
Moves the element to the head of the queue, overriding the last one when queue is out of space and moving all others one place right.
+[in] | v | Element to move to the head of the queue. |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+Directories | |
directory | stdex |
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+
+ stdex
+
+ Additional templates and function helpers for Microsoft Active Template Library
+ |
+