duration_t Struct Reference

#include <duration_t.h>

Inheritance diagram for duration_t:

Collaboration diagram for duration_t:

Public Member Functions
	duration_t ()
	Constructor. More...
	duration_t (uint32_t const &seconds)
	Constructor. More...
bool	operator== (const uint32_t &value) const
	Equality comparison. More...
bool	operator!= (const uint32_t &value) const
	Inequality comparison. More...
uint8_t	year () const
	Formats the duration as years. More...
uint16_t	day () const
	Formats the duration as days. More...
uint32_t	hour () const
	Formats the duration as hours. More...
uint32_t	minute () const
	Formats the duration as minutes. More...
uint32_t	second () const
	Formats the duration as seconds. More...
char *	toString (char *const buffer) const
	Formats the duration as a string. More...
uint8_t	toDigital (char *buffer, bool with_days=false) const
	Formats the duration as a string. More...

Public Attributes
uint32_t	value
	Duration is stored in seconds. More...

Detailed Description

Marlin 3D Printer Firmware Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]

Based on Sprinter and grbl. Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Constructor & Destructor Documentation

duration_t() [1/2]

duration_t::duration_t

(

)

Constructor.

    : duration_t(0) {};

duration_t() [2/2]

duration_t::duration_t

(

uint32_t const &

seconds

)

Constructor.

Parameters

seconds

The number of seconds

                                      {
    this->value = seconds;
  }

Member Function Documentation

operator==()

bool duration_t::operator==

(

const uint32_t &

value

)

const

Equality comparison.

Overloads the equality comparison operator

Parameters

value

The number of seconds to compare to

Returns

True if both durations are equal

                                               {
    return (this->value == value);
  }

Here is the caller graph for this function:

operator!=()

bool duration_t::operator!=

(

const uint32_t &

value

)

const

Inequality comparison.

Overloads the inequality comparison operator

Parameters

value

The number of seconds to compare to

Returns

False if both durations are equal

                                               {
    return ! this->operator==(value);
  }

Here is the call graph for this function:

year()

uint8_t duration_t::year

(

)

const

Formats the duration as years.

Returns

The number of years

                              {
    return this->day() / 365;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

day()

uint16_t duration_t::day

(

)

const

Formats the duration as days.

Returns

The number of days

                              {
    return this->hour() / 24;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

hour()

uint32_t duration_t::hour

(

)

const

Formats the duration as hours.

Returns

The number of hours

                               {
    return this->minute() / 60;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

minute()

uint32_t duration_t::minute

(

)

const

Formats the duration as minutes.

Returns

The number of minutes

                                 {
    return this->second() / 60;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

second()

uint32_t duration_t::second

(

)

const

Formats the duration as seconds.

Returns

The number of seconds

                                 {
    return this->value;
  }

Here is the caller graph for this function:

toString()

char* duration_t::toString

(

char *const

buffer

)

const

Formats the duration as a string.

String will be formated using a "full" representation of duration

Parameters

buffer

The array pointed to must be able to accommodate 21 bytes

Output examples: 123456789012345678901 (strlen) 135y 364d 23h 59m 59s 364d 23h 59m 59s 23h 59m 59s 59m 59s 59s

                                            {
    int y = this->year(),
        d = this->day() % 365,
        h = this->hour() % 24,
        m = this->minute() % 60,
        s = this->second() % 60;
 
    if (y) sprintf_P(buffer, PSTR("%iy %id %ih %im %is"), y, d, h, m, s);
    else if (d) sprintf_P(buffer, PSTR("%id %ih %im %is"), d, h, m, s);
    else if (h) sprintf_P(buffer, PSTR("%ih %im %is"), h, m, s);
    else if (m) sprintf_P(buffer, PSTR("%im %is"), m, s);
    else sprintf_P(buffer, PSTR("%is"), s);
    return buffer;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

toDigital()

uint8_t duration_t::toDigital	(	char *	buffer,
		bool	with_days = false
	)		const

Formats the duration as a string.

String will be formated using a "digital" representation of duration

Parameters

buffer

The array pointed to must be able to accommodate 10 bytes

Output examples: 123456789 (strlen) 99:59 11d 12:33

                                                              {
    uint16_t h = uint16_t(this->hour()),
             m = uint16_t(this->minute() % 60UL);
    if (with_days) {
      uint16_t d = this->day();
      sprintf_P(buffer, PSTR("%hud %02hu:%02hu"), d, h % 24, m);
      return d >= 10 ? 9 : 8;
    }
    else if (h < 100) {
      sprintf_P(buffer, PSTR("%02hu:%02hu"), h, m);
      return 5;
    }
    else {
      sprintf_P(buffer, PSTR("%hu:%02hu"), h, m);
      return 6;
    }
  }

Here is the call graph for this function:

Member Data Documentation

value

uint32_t duration_t::value

Duration is stored in seconds.