UpdateSeq Class Reference

This is a sequence number that increments monotonically. More...

#include "updateSeq.h"

Public Member Functions
constexpr	UpdateSeq ()
	Creates an UpdateSeq in the 'initial' state. More...
	UpdateSeq (const UpdateSeq &copy)
constexpr	UpdateSeq (const UpdateSeq &&from) noexcept
void	clear ()
	Resets the UpdateSeq to the 'initial' state. More...
AtomicAdjust::Integer	get_seq () const
bool	is_fresh () const
	Returns true if the UpdateSeq is in the 'fresh' state. More...
bool	is_initial () const
	Returns true if the UpdateSeq is in the 'initial' state. More...
bool	is_old () const
	Returns true if the UpdateSeq is in the 'old' state. More...
bool	is_special () const
	Returns true if the UpdateSeq is in any special states, i.e. More...
bool	operator != (const UpdateSeq &other) const
bool	operator > (const UpdateSeq &other) const
bool	operator >= (const UpdateSeq &other) const
UpdateSeq	operator++ ()
UpdateSeq	operator++ (int)
bool	operator< (const UpdateSeq &other) const
bool	operator<= (const UpdateSeq &other) const
UpdateSeq &	operator= (const UpdateSeq &copy)
bool	operator== (const UpdateSeq &other) const
void	output (std::ostream &out) const

Static Public Member Functions
static constexpr UpdateSeq	fresh ()
static constexpr UpdateSeq	initial ()
static constexpr UpdateSeq	old ()

Public Attributes
	get_seq
	Returns the internal integer value associated with the UpdateSeq. More...

Detailed Description

This is a sequence number that increments monotonically.

It can be used to track cache updates, or serve as a kind of timestamp for any changing properties.

A special class is used instead of simply an int, so we can elegantly handle such things as wraparound and special cases. There are two special cases. Firstly, a sequence number is 'initial' when it is first created. This sequence is older than any other sequence number. Secondly, a sequence number may be explicitly set to 'old'. This is older than any other sequence number except 'initial'. Finally, we have the explicit number 'fresh', which is newer than any other sequence number. All other sequences are numeric and are monotonically increasing.

Definition at line 37 of file updateSeq.h.

Constructor & Destructor Documentation

UpdateSeq()

constexpr UpdateSeq::UpdateSeq

(

)

Creates an UpdateSeq in the 'initial' state.

Definition at line 25 of file updateSeq.I.

Member Function Documentation

clear()

void UpdateSeq::clear ( )

inline

Resets the UpdateSeq to the 'initial' state.

Definition at line 55 of file updateSeq.I.

References AtomicAdjustDummyImpl::set().

is_fresh()

bool UpdateSeq::is_fresh ( ) const

inline

Returns true if the UpdateSeq is in the 'fresh' state.

Definition at line 79 of file updateSeq.I.

References AtomicAdjustDummyImpl::get().

is_initial()

bool UpdateSeq::is_initial ( ) const

inline

Returns true if the UpdateSeq is in the 'initial' state.

Definition at line 63 of file updateSeq.I.

References AtomicAdjustDummyImpl::get().

is_old()

bool UpdateSeq::is_old ( ) const

inline

Returns true if the UpdateSeq is in the 'old' state.

Definition at line 71 of file updateSeq.I.

References AtomicAdjustDummyImpl::get().

is_special()

bool UpdateSeq::is_special ( ) const

inline

Returns true if the UpdateSeq is in any special states, i.e.

'initial', 'old', or 'fresh'.

Definition at line 88 of file updateSeq.I.

References AtomicAdjustDummyImpl::get().

Member Data Documentation

get_seq

AtomicAdjust::Integer UpdateSeq::get_seq

inline

Returns the internal integer value associated with the UpdateSeq.

Useful for debugging only.

Definition at line 69 of file updateSeq.h.

---

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

• panda/src/putil/updateSeq.h
• panda/src/putil/updateSeq.I