nlib
nn::nlib::z Class Reference

A dummy class provided for the convenience of creating a document, which does not exist. More...

#include <manual_en_z.h>

Public Member Functions

 z () noexcept
 Instantiates the object with default parameters (default constructor).
 
void z_needs_init () noexcept
 Instantiates the object with default parameters (default constructor). Requires initialization with Init() after execution.
 
 ~z () noexcept
 Destructor.
 
 z (z &&) noexcept
 Instantiates the object (move constructor).
 
zoperator= (z &&) noexcept
 Move assignment operator.
 
 z (const z &) noexcept
 Copy constructor.
 
zoperator= (const z &) noexcept
 Assignment operator.
 
errno_t Init () noexcept
 Initializes an object. Returns 0 if successful.
 
bool InitB () noexcept
 Initializes an object. Returns true if successful.
 
errno_t Init_settings (const z &settings) noexcept
 Initializes by specifying the behavior option. Returns 0 if successful. More...
 
void Overload_omitarg () noexcept
 A parameter omitted version of the above function.
 
void Overload_omitarg_null () noexcept
 A parameter omitted version of the above function which passes nullptr as a parameter.
 
void Overload_omitarg_false () noexcept
 A parameter omitted version of the above function which passes false as a parameter.
 
void Overload_omitarg_settings () noexcept
 A parameter omitted version of the above function which passes settings as the default value.
 
void Overload_omitarg_template () noexcept
 A template overload of the above function.
 
void Overload_omitarg_cstr () noexcept
 A parameter omitted version of the above function which receives a null terminated string.
 
void Overload_const () const noexcept
 The const decoration version of the above function.
 
void Reset () noexcept
 Resets this object to the state immediately after the default constructor was executed.
 
void iterator () noexcept
 A random-access iterator.
 
void const_iterator () noexcept
 Read-only random-access iterator.
 
void forward_iterator () noexcept
 A forward iterator.
 
void const_forward_iterator () noexcept
 Read-only forward iterator.
 
void reverse_iterator () noexcept
 A reverse iterator.
 
void const_reverse_iterator () noexcept
 Read-only reverse iterator.
 
void reference () noexcept
 A reference to an element.
 
void const_reference () noexcept
 Read-only reference to an element.
 
void pointer () noexcept
 Pointer to the element.
 
void const_pointer () noexcept
 Read-only pointer to an element.
 
void begin () noexcept
 Gets the iterator pointing to the first element.
 
void begin_const () const noexcept
 Gets the read-only iterator pointing to the first element.
 
void end () noexcept
 Gets the iterator pointing beyond the last element.
 
void end_const () const noexcept
 Gets the read-only iterator pointing beyond the last element.
 
void rbegin () noexcept
 Gets the reverse iterator pointing to the last element.
 
void rbegin_const () const noexcept
 Gets the read-only reverse iterator pointing to the last element.
 
void rend () noexcept
 Gets the reverse iterator pointing ahead of the first element.
 
void rend_const () const noexcept
 Gets the read-only reverse iterator pointing ahead of the first element.
 
void front () noexcept
 Gets a reference to the first element.
 
void back () noexcept
 Gets a reference to the last element.
 
int & at (size_t n) noexcept
 Gets the nth element. n must be less than the number of stored elements. More...
 
size_t size () const noexcept
 Returns the number of stored elements.
 
bool empty () const noexcept
 Returns true if the number of stored elements is 0, or returns false otherwise.
 
bool opbool () const noexcept
 Returns true if the object is in a valid status, or returns false otherwise.
 
bool opbool_err () const noexcept
 Returns true if the object has been initialized and an error has not occurred inside, or returns false if an error has occurred inside.
 

Detailed Description

A dummy class provided for the convenience of creating a document, which does not exist.

Definition at line 8 of file manual_en_z.h.

Member Function Documentation

◆ at()

int& nn::nlib::z::at ( size_t  n)
noexcept

Gets the nth element. n must be less than the number of stored elements.

Parameters
[in]nThe position of an element.
Returns
Reference to the nth element.

◆ Init_settings()

errno_t nn::nlib::z::Init_settings ( const z settings)
noexcept

Initializes by specifying the behavior option. Returns 0 if successful.

Parameters
[in]settingsBehavior options.
Return values
0Success.
EALREADYAlready initialized.
ENOMEMIndicates that internal memory allocation failed.
EINVALIndicates that the specification of behavior options was invalid.

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