Face Engine SDK  5.25.0
A face detection, recognition and tracking engine.
fsdk::Sizer Struct Reference

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

#include <Sizer.h>

List of all members.

Public Member Functions

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

Initializes sizer with another sizer value.

Parameters:
[in]otheranother sizer.

Member Function Documentation

void fsdk::Sizer::append ( size_t  bytes) [inline]

Append bytes to current byte count.

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

Append other sizer byte count to current byte count.

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

Get current size.

Returns:
current byte count.
size_t fsdk::Sizer::getGBytes ( ) const [inline]

Get current size.

Returns:
current size in gbytes (truncated).
size_t fsdk::Sizer::getKBytes ( ) const [inline]

Get current size.

Returns:
current size in kbytes (truncated).
size_t fsdk::Sizer::getMBytes ( ) const [inline]

Get current size.

Returns:
current size in mbytes (truncated).
bool fsdk::Sizer::isEmpty ( ) const [inline]

Check whether size is zero.

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

Check whether size is zero.

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

Check if two sizers are not equal.

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

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) [inline]

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) [inline]

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 [inline]

Check if two sizers are equal.

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

Swap contents with an other sizer.

Parameters:
[inout]other sizer to swap with.

The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines