| Face Engine SDK 5.33.0 A face detection, recognition and tracking engine.

Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
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.
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.
Sizer & | operator<< (size_t bytes) noexcept
| Append bytes to current byte count.
Sizer & | operator<< (const Sizer &other) noexcept
| Append other sizer byte count to current byte count.
Sizer & | operator= (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

## ◆ Sizer()

fsdk::Sizer::Sizer | ( | const Sizer & | other | ) |
| inline noexcept

Initializes sizer with another sizer value.

Parameters

  [in] | other | another sizer.

## Member Function Documentation

## ◆ append() [1/2]

void fsdk::Sizer::append | ( | const Sizer & | other | ) |
| inline noexcept

Append other sizer byte count to current byte count.

Parameters

  [in] | other | sizer to take bytes from.

## ◆ append() [2/2]

void fsdk::Sizer::append | ( | size_t | bytes | ) |
| inline noexcept

Append bytes to current byte count.

Parameters

  [in] | bytes | number of bytes to append.

## ◆ getBytes()

size_t fsdk::Sizer::getBytes | ( |  | ) | const
| inline noexcept

Get current size.

Returns
  current byte count.

## ◆ getGBytes()

size_t fsdk::Sizer::getGBytes | ( |  | ) | const
| inline noexcept

Get current size.

Returns
  current size in gbytes (truncated).

## ◆ getKBytes()

size_t fsdk::Sizer::getKBytes | ( |  | ) | const
| inline noexcept

Get current size.

Returns
  current size in kbytes (truncated).

## ◆ getMBytes()

size_t fsdk::Sizer::getMBytes | ( |  | ) | const
| inline noexcept

Get current size.

Returns
  current size in mbytes (truncated).

## ◆ isEmpty()

bool fsdk::Sizer::isEmpty | ( |  | ) | const
| inline noexcept

Check whether size is zero.

Returns
  true if current byte count is zero.

## ◆ operator bool()

fsdk::Sizer::operator bool | ( |  | ) | const
| inline noexcept

Check whether size is zero.

Returns
  true if current byte count is not zero.

## ◆ operator!=()

bool fsdk::Sizer::operator!= | ( | const Sizer & | other | ) | const
| inline noexcept

Check if two sizers are not equal.

Parameters

  [in] | other | sizer.

Returns
  true if sizers are not equal.

## ◆ operator<<() [1/2]

Sizer & fsdk::Sizer::operator<< | ( | const Sizer & | other | ) |
| inline noexcept

Append other sizer byte count to current byte count.

Parameters

  [in] | other | sizer to take bytes from.

Returns
  sizer reference for call chaining.

## ◆ operator<<() [2/2]

Sizer & fsdk::Sizer::operator<< | ( | size_t | bytes | ) |
| inline noexcept

Append bytes to current byte count.

Parameters

  [in] | bytes | number of bytes to append.

Returns
  sizer reference for call chaining.

## ◆ operator=()

Sizer & fsdk::Sizer::operator= | ( | const Sizer & | other | ) |
| inline noexcept

Assign value of another sizer.

Parameters

  [in] | other | sizer to take bytes from.

Returns
  sizer reference for call chaining.

## ◆ operator==()

bool fsdk::Sizer::operator== | ( | const Sizer & | other | ) | const
| inline noexcept

Check if two sizers are equal.

Parameters

  [in] | other | sizer.

Returns
  true if sizers are equal.

## ◆ swap()

void fsdk::Sizer::swap | ( | Sizer & | other | ) |
| inline noexcept

Swap contents with an other sizer.

Parameters

  [in,out] | other | sizer to swap with.

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

- fsdk.framework/Headers/Types/Sizer.h