Fw::CircularIndex Class Reference

#include <Fw/DataStructures/CircularIndex.hpp>

Public Member Functions
	CircularIndex ()
	Zero-argument constructor. More...
	CircularIndex (FwSizeType modulus, FwSizeType value=0)
	Constructor with specified members. More...
	CircularIndex (const CircularIndex &ci)
	Copy constructor. More...
	~CircularIndex ()=default
	Destructor. More...
CircularIndex &	operator= (const CircularIndex &ci)
	operator= More...
FwSizeType	getValue () const
void	setValue (FwSizeType value)
	Set the index value. More...
FwSizeType	getModulus () const
	Get the modulus. More...
void	setModulus (FwSizeType modulus)
	Set the modulus. More...
FwSizeType	increment (FwSizeType amount=1)
FwSizeType	decrement (FwSizeType amount=1)

Detailed Description

Definition at line 15 of file CircularIndex.hpp.

Constructor & Destructor Documentation

CircularIndex() [1/3]

Fw::CircularIndex::CircularIndex ( )

inline

Zero-argument constructor.

Definition at line 22 of file CircularIndex.hpp.

CircularIndex() [2/3]

Fw::CircularIndex::CircularIndex ( FwSizeType  modulus, FwSizeType  value = 0  )

inlineexplicit

Constructor with specified members.

Parameters

modulus	The modulus
value	The initial value

Definition at line 25 of file CircularIndex.hpp.

CircularIndex() [3/3]

Fw::CircularIndex::CircularIndex ( const CircularIndex &  ci )

inline

Copy constructor.

Definition at line 34 of file CircularIndex.hpp.

~CircularIndex()

Fw::CircularIndex::~CircularIndex ( )

default

Destructor.

Member Function Documentation

decrement()

FwSizeType Fw::CircularIndex::decrement ( FwSizeType  amount = 1 )

inline

Decrement the index value

Returns

The new value

Parameters

amount

The amount by which to decrement

Definition at line 92 of file CircularIndex.hpp.

getModulus()

FwSizeType Fw::CircularIndex::getModulus ( ) const

inline

Get the modulus.

Definition at line 68 of file CircularIndex.hpp.

getValue()

FwSizeType Fw::CircularIndex::getValue ( ) const

inline

Get the index value

Returns

The index value

Definition at line 55 of file CircularIndex.hpp.

increment()

FwSizeType Fw::CircularIndex::increment ( FwSizeType  amount = 1 )

inline

Increment the index value

Returns

The new value

Parameters

amount

The amount by which to increment

Definition at line 82 of file CircularIndex.hpp.

operator=()

CircularIndex& Fw::CircularIndex::operator= ( const CircularIndex &  ci )

inline

operator=

Definition at line 45 of file CircularIndex.hpp.

setModulus()

void Fw::CircularIndex::setModulus ( FwSizeType  modulus )

inline

Set the modulus.

Parameters

modulus

The modulus value

Definition at line 74 of file CircularIndex.hpp.

setValue()

void Fw::CircularIndex::setValue ( FwSizeType  value )

inline

Set the index value.

Parameters

value

The index value

Definition at line 61 of file CircularIndex.hpp.

---

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

• Fw/DataStructures/CircularIndex.hpp