mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step > Class Template Reference

array of dependent values More...

#include <TDependentValues.h>

Collaboration diagram for mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >:

[legend]

List of all members.

Public Types
typedef _Ty	ValueType
typedef _Ty	ValueArray [_Count]
Public Member Functions
	TDependentValues ()
const ValueType &	operator[] (size_t nIndex) const
ValueType	GetValue (size_t nIndex) const
ValueType	GetSum () const
bool	GetValuesOk () const
void	SetEqual ()
void	SetAllValues (const ValueArray *pvtValues)
void	SetValue (size_t nIndex, ValueType new_val)
Protected Member Functions
virtual void	DoUpdateValues (size_t nIndex)
virtual void	SetAutoFixup (bool bAutoFixup)
virtual bool	GetAutoFixup () const

---

Detailed Description

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>
class mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >

array of dependent values

The values of this class are dependent in the following sense:

• all values greater than or equal _Min
• all values less than or equal _Max
• sum of all values equals _Max

Definition at line 53 of file TDependentValues.h.

---

Member Typedef Documentation

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

typedef _Ty mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::ValueType

Definition at line 57 of file TDependentValues.h.

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

typedef _Ty mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::ValueArray[_Count]

Definition at line 58 of file TDependentValues.h.

---

Constructor & Destructor Documentation

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::TDependentValues

(

)

[inline]

Create with equal values

Definition at line 62 of file TDependentValues.h.

References mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetEqual().

        : m_bUpdate(false)
        , m_bFixup(true)
    {
        SetEqual();
    }

Here is the call graph for this function:

---

Member Function Documentation

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

const ValueType& mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::operator[]

(

size_t

nIndex

)

const [inline]

Parameters:

nIndex

index of value to access

Returns:

read access by value

Definition at line 72 of file TDependentValues.h.

    {
        assert(nIndex < _Count);
        return m_vtValues[nIndex];
    }

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

ValueType mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::GetValue

(

size_t

nIndex

)

const [inline]

Parameters:

nIndex

index of value to access

Returns:

read access by copy

Definition at line 81 of file TDependentValues.h.

    {
        assert(nIndex < _Count);
        return m_vtValues[nIndex];
    }

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

ValueType mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::GetSum

(

)

const [inline]

Returns:

the sum of all values, should be _Max

Definition at line 89 of file TDependentValues.h.

    {
        ValueType sum(0);

        for(size_t nPos = 0; nPos < _Count; ++nPos)
        {
            sum += m_vtValues[nPos];
        }
        return sum;
    }

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

bool mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::GetValuesOk

(

)

const [inline]

Returns:

whether all conditions apply to values

• all values greater than or equal _Min
• all values less than or equal _Max
• sum of all values equals _Max

Definition at line 105 of file TDependentValues.h.

    {
        ValueType sum(0);

        for(size_t nPos = 0; nPos < _Count; ++nPos)
        {
            if (m_vtValues[nPos] < _Min)
            {
                return false;
            }
            sum += m_vtValues[nPos];
        }
        return sum == _Max;
    }

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

void mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetEqual

(

)

[inline]

Set all values to the same value (_Max/_Count) and then call DoUpdateValues(-1).

Definition at line 123 of file TDependentValues.h.

References mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::DoUpdateValues().

Referenced by mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::TDependentValues().

    {
        if (!m_bUpdate)
        {
            m_bUpdate = true;

            // Correct the values
            for(size_t nPos = 0; nPos < _Count; ++nPos)
            {
                m_vtValues[nPos] = _Max / _Count;
            }

            FixupSum();

            // now that all values are correct again we can notify
            DoUpdateValues(-1);

            m_bUpdate = false;
        }
    }

Here is the call graph for this function:

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

void mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetAllValues

(

const ValueArray *

pvtValues

)

[inline]

Set all parameters at once

Parameters:

pvtValues

pointer to array of new values must have exactly _Count values

Definition at line 149 of file TDependentValues.h.

References mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::DoUpdateValues().

    {
        for(size_t nPos = 0; nPos < _Count; ++nPos)
        {
            m_vtValues[nPos] = (*pvtValues)[nPos];
        }
        FixupSum();
        DoUpdateValues(-1);
    }

Here is the call graph for this function:

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

void mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetValue	(	size_t	nIndex,
		ValueType	new_val
	)			[inline]

Set a single value and correct the others automatically

Parameters:

	nIndex	index of value to change
	new_val	value to set

Definition at line 164 of file TDependentValues.h.

References mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::DoUpdateValues(), and min.

    {
        if (!m_bUpdate)
        {
            m_bUpdate = true;

            if (!m_bFixup)
            {
                m_vtValues[nIndex] = new_val;
                DoUpdateValues(nIndex);
            }
            // check whether at least one value was changed, diff != 0
            else if (m_vtValues[nIndex] != new_val)
            {
                // if a new value was set 1000 then we need to set all other to zero
                if (new_val >= _Max)
                {
                    for(size_t nPos = 0; nPos < _Count; ++nPos)
                    {
                        m_vtValues[nPos] = nPos == nIndex ? _Max : _Min;
                    }
                }
                else
                {
                    // handle the normal case (and later the case when a value was set to zero)
                    ValueType  count_min_one = _Count - 1;
                    ValueType  diff_val  = _Step * (new_val - m_vtValues[nIndex]) / count_min_one;
                    ValueType  miss_val  = 0;
                    ValueType  max_val   = _Min;
                    size_t     nIndexMax = 0;

                    for(size_t nPos = 0; nPos < _Count; ++nPos)
                    {
                        if (nPos == nIndex)
                        {
                            m_vtValues[nPos] += diff_val * count_min_one;
                            m_vtValues[nPos] = min(m_vtValues[nPos], _Max);
                        }
                        else
                        {
                            m_vtValues[nPos] -= diff_val;
                        }

                        if (m_vtValues[nPos] < _Min)
                        {
                            miss_val += _Min - m_vtValues[nPos];
                            m_vtValues[nPos] = _Min;
                        }
                        else if (m_vtValues[nPos] >= max_val)
                        {
                            nIndexMax = nPos;
                            max_val = m_vtValues[nPos];
                        }
                    }

                    if (miss_val)
                    {
                        m_vtValues[nIndexMax] -= miss_val;
                    }

                    FixupSum();
                }

                DoUpdateValues(nIndex);
            }

            m_bUpdate = false;
        }
    }

Here is the call graph for this function:

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

virtual void mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::DoUpdateValues

(

size_t

nIndex

)

[inline, protected, virtual]

Parameters:

nIndex

index of updated value or -1 if all values were set simultaineously.

Definition at line 239 of file TDependentValues.h.

Referenced by mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetAllValues(), mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetAutoFixup(), mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetEqual(), and mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetValue().

    {
        // nothing to do here
    }

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

virtual void mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::SetAutoFixup

(

bool

bAutoFixup

)

[inline, protected, virtual]

Parameters:

bAutoFixup

whether to automatically fix values upon modification

Definition at line 246 of file TDependentValues.h.

References mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::DoUpdateValues().

    {
        m_bFixup = bAutoFixup;
        if (m_bFixup)
        {
            FixupSum();
            DoUpdateValues(-1);
        }
    }

Here is the call graph for this function:

template<typename _Ty, size_t _Count, _Ty _Min, _Ty _Max, _Ty _Step>

virtual bool mbo::TDependentValues< _Ty, _Count, _Min, _Max, _Step >::GetAutoFixup

(

)

const [inline, protected, virtual]

Returns:

whether auto fixup mode is active

Definition at line 258 of file TDependentValues.h.

    {
        return m_bFixup;
    }

---

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

• TDependentValues.h

---