Face Engine SDK  5.21.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::Sizer Struct Reference

Helper entity to measure size of dynamic objects in memory. More...

#include <Sizer.h>

Public Member Functions

 Sizer () noexcept
 Initializes sizer with zero.
 
 Sizer (const Sizer &other) noexcept
 Initializes sizer with another sizer value. More...
 
void append (size_t bytes) noexcept
 Append bytes to current byte count. More...
 
void append (const Sizer &other) noexcept
 Append other sizer byte count to current byte count. More...
 
void reset () noexcept
 Reset byte count to zero.
 
size_t getBytes () const noexcept
 Get current size. More...
 
size_t getKBytes () const noexcept
 Get current size. More...
 
size_t getMBytes () const noexcept
 Get current size. More...
 
size_t getGBytes () const noexcept
 Get current size. More...
 
 operator size_t () const noexcept
 Cast to size type.
 
bool isEmpty () const noexcept
 Check whether size is zero. More...
 
 operator bool () const noexcept
 Check whether size is zero. More...
 
Sizeroperator<< (size_t bytes) noexcept
 Append bytes to current byte count. More...
 
Sizeroperator<< (const Sizer &other) noexcept
 Append other sizer byte count to current byte count. More...
 
Sizeroperator= (const Sizer &other) noexcept
 Assign value of another sizer. More...
 
bool operator== (const Sizer &other) const noexcept
 Check if two sizers are equal. More...
 
bool operator!= (const Sizer &other) const noexcept
 Check if two sizers are not equal. More...
 
void swap (Sizer &other) noexcept
 

Protected Attributes

size_t m_bytes
 Current measured size in bytes.
 

Detailed Description

Helper entity to measure size of dynamic objects in memory.

Constructor & Destructor Documentation

fsdk::Sizer::Sizer ( const Sizer other)
inlinenoexcept

Initializes sizer with another sizer value.

Parameters
[in]otheranother sizer.

Member Function Documentation

void fsdk::Sizer::append ( size_t  bytes)
inlinenoexcept

Append bytes to current byte count.

Parameters
[in]bytesnumber of bytes to append.
void fsdk::Sizer::append ( const Sizer other)
inlinenoexcept

Append other sizer byte count to current byte count.

Parameters
[in]othersizer to take bytes from.
size_t fsdk::Sizer::getBytes ( ) const
inlinenoexcept

Get current size.

Returns
current byte count.
size_t fsdk::Sizer::getGBytes ( ) const
inlinenoexcept

Get current size.

Returns
current size in gbytes (truncated).
size_t fsdk::Sizer::getKBytes ( ) const
inlinenoexcept

Get current size.

Returns
current size in kbytes (truncated).
size_t fsdk::Sizer::getMBytes ( ) const
inlinenoexcept

Get current size.

Returns
current size in mbytes (truncated).
bool fsdk::Sizer::isEmpty ( ) const
inlinenoexcept

Check whether size is zero.

Returns
true if current byte count is zero.
fsdk::Sizer::operator bool ( ) const
inlinenoexcept

Check whether size is zero.

Returns
true if current byte count is not zero.
bool fsdk::Sizer::operator!= ( const Sizer other) const
inlinenoexcept

Check if two sizers are not equal.

Parameters
[in]othersizer.
Returns
true if sizers are not equal.
Sizer& fsdk::Sizer::operator<< ( size_t  bytes)
inlinenoexcept

Append bytes to current byte count.

Parameters
[in]bytesnumber of bytes to append.
Returns
sizer reference for call chaining.
Sizer& fsdk::Sizer::operator<< ( const Sizer other)
inlinenoexcept

Append other sizer byte count to current byte count.

Parameters
[in]othersizer to take bytes from.
Returns
sizer reference for call chaining.
Sizer& fsdk::Sizer::operator= ( const Sizer other)
inlinenoexcept

Assign value of another sizer.

Parameters
[in]othersizer to take bytes from.
Returns
sizer reference for call chaining.
bool fsdk::Sizer::operator== ( const Sizer other) const
inlinenoexcept

Check if two sizers are equal.

Parameters
[in]othersizer.
Returns
true if sizers are equal.
void fsdk::Sizer::swap ( Sizer other)
inlinenoexcept

Swap contents with an other sizer.

Parameters
[in,out]othersizer to swap with.

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