stmg::AlphaTraitSet Class Reference

Inheritance diagram for stmg::AlphaTraitSet:

Public Member Functions
	AlphaTraitSet () noexcept
	Constructs set containing the empty value. More...
	AlphaTraitSet (int32_t nValue) noexcept
	AlphaTraitSet (int32_t nFromValue, int32_t nToValue) noexcept
	AlphaTraitSet (int32_t nFromValue, int32_t nToValue, int32_t nStep) noexcept
	AlphaTraitSet (const std::vector< int32_t > &aValues) noexcept
	AlphaTraitSet (const IntSet &oIntSet, bool bWithEmptyValue) noexcept
	AlphaTraitSet (IntSet &&oIntSet, bool bWithEmptyValue) noexcept
	AlphaTraitSet (const AlphaTraitSet &oSource) noexcept=default
	AlphaTraitSet (AlphaTraitSet &&oSource) noexcept=default
AlphaTraitSet &	operator= (const AlphaTraitSet &oSource) noexcept=default
AlphaTraitSet &	operator= (AlphaTraitSet &&oSource) noexcept=default
bool	hasEmptyValue () const noexcept override final
	Whether the set contains the empty value. More...
int32_t	getTotValues () const noexcept override final
	Get the total number of values in this tile trait indexed set. More...
void	dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
	Dumps the trait set. More...
Public Member Functions inherited from stmg::IntTraitSet
bool	hasEmptyValue () const noexcept override
	Whether the trait set contains the empty value. More...
int32_t	getTotValues () const noexcept override
	Get the total number of values in this tile trait indexed set. More...
bool	setTileTraitValueByIndex (Tile &oTile, int32_t nIdx) const noexcept override final
	Sets the trait of a tile to the value identified by an index. More...
int32_t	getIndexOfTileTraitValue (const Tile &oTile) const noexcept override final
	Gets the index of the value of the tile's trait in the set. More...
void	dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
	Dumps the trait set. More...
Public Member Functions inherited from stmg::TraitSet
virtual	~TraitSet () noexcept=default

Protected Member Functions
std::pair< bool, int32_t >	getTraitValue (const Tile &oTile) const noexcept override
	Either the value of the tile's trait or empty. More...
void	setTileTraitValue (Tile &oTile, int32_t nValue) const noexcept override
	Sets the tile's trait value. More...
void	resetTileTraitValue (Tile &oTile) const noexcept override
	Sets the tile's trait to empty. More...
Protected Member Functions inherited from stmg::IntTraitSet
	IntTraitSet () noexcept
	Constructs empty trait set. More...
	IntTraitSet (int32_t nValue) noexcept
	Constructs trait set with one value. More...
	IntTraitSet (int32_t nFromValue, int32_t nToValue) noexcept
	Constructs trait set with ordered value range. More...
	IntTraitSet (int32_t nFromValue, int32_t nToValue, int32_t nStep) noexcept
	Constructs trait set with ordered stepped value range. More...
	IntTraitSet (const std::vector< int32_t > &aValues) noexcept
	Constructs trait set with array of values. More...
	IntTraitSet (const IntSet &oIntSet) noexcept
	Constructs trait set from an integer set. More...
	IntTraitSet (IntSet &&oIntSet) noexcept
	Constructs trait set from an integer set. More...
	IntTraitSet (const IntTraitSet &oSource) noexcept=default
	IntTraitSet (IntTraitSet &&oSource) noexcept=default
IntTraitSet &	operator= (const IntTraitSet &oSource) noexcept=default
IntTraitSet &	operator= (IntTraitSet &&oSource) noexcept=default
bool	hasValue (int32_t nValue) const noexcept

Constructor & Destructor Documentation

AlphaTraitSet() [1/9]

stmg::AlphaTraitSet::AlphaTraitSet ( )

noexcept

Constructs set containing the empty value.

If you want to construct the empty set use AlphaTraitSet({}) instead.

AlphaTraitSet() [2/9]

stmg::AlphaTraitSet::AlphaTraitSet ( int32_t  nValue )

explicitnoexcept

AlphaTraitSet() [3/9]

stmg::AlphaTraitSet::AlphaTraitSet ( int32_t  nFromValue, int32_t  nToValue  )

noexcept

AlphaTraitSet() [4/9]

stmg::AlphaTraitSet::AlphaTraitSet ( int32_t  nFromValue, int32_t  nToValue, int32_t  nStep  )

noexcept

AlphaTraitSet() [5/9]

stmg::AlphaTraitSet::AlphaTraitSet ( const std::vector< int32_t > &  aValues )

explicitnoexcept

AlphaTraitSet() [6/9]

stmg::AlphaTraitSet::AlphaTraitSet ( const IntSet &  oIntSet, bool  bWithEmptyValue  )

noexcept

AlphaTraitSet() [7/9]

stmg::AlphaTraitSet::AlphaTraitSet ( IntSet &&  oIntSet, bool  bWithEmptyValue  )

noexcept

AlphaTraitSet() [8/9]

stmg::AlphaTraitSet::AlphaTraitSet ( const AlphaTraitSet &  oSource )

defaultnoexcept

AlphaTraitSet() [9/9]

stmg::AlphaTraitSet::AlphaTraitSet ( AlphaTraitSet &&  oSource )

defaultnoexcept

Member Function Documentation

dump()

void stmg::AlphaTraitSet::dump ( int32_t  nIndentSpaces, bool  bHeader  ) const

overridevirtualnoexcept

Dumps the trait set.

This only works if NDEBUG macro is not defined.

Implements stmg::TraitSet.

getTotValues()

int32_t stmg::AlphaTraitSet::getTotValues ( ) const

finaloverridevirtualnoexcept

Get the total number of values in this tile trait indexed set.

The empty value, if present, is also counted.

Returns

The number of values. Is >= 0.

Implements stmg::TraitSet.

getTraitValue()

std::pair<bool, int32_t> stmg::AlphaTraitSet::getTraitValue ( const Tile &  oTile ) const

overrideprotectedvirtualnoexcept

Either the value of the tile's trait or empty.

Parameters

oTile

The tile

Returns

The pair of bool telling whether value empty and the value if not empty.

Implements stmg::IntTraitSet.

hasEmptyValue()

bool stmg::AlphaTraitSet::hasEmptyValue ( ) const

finaloverridevirtualnoexcept

Whether the set contains the empty value.

Returns

Whether the set contains the empty value.

Implements stmg::TraitSet.

operator=() [1/2]

AlphaTraitSet& stmg::AlphaTraitSet::operator= ( const AlphaTraitSet &  oSource )

defaultnoexcept

operator=() [2/2]

AlphaTraitSet& stmg::AlphaTraitSet::operator= ( AlphaTraitSet &&  oSource )

defaultnoexcept

resetTileTraitValue()

void stmg::AlphaTraitSet::resetTileTraitValue ( Tile &  oTile ) const

overrideprotectedvirtualnoexcept

Sets the tile's trait to empty.

Parameters

oTile

The tile to modify.

Implements stmg::IntTraitSet.

setTileTraitValue()

void stmg::AlphaTraitSet::setTileTraitValue ( Tile &  oTile, int32_t  nValue  ) const

overrideprotectedvirtualnoexcept

Sets the tile's trait value.

Parameters

oTile	The tile to modify.
nValue	The new value.

Implements stmg::IntTraitSet.