IParamBlock2::ParameterIterator Class Reference

Provides standard C++ iteration functionality for the parameters stored by an IParamBlock2. More...

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/iparamb2.h>

Public Member Functions
	ParameterIterator (IParamBlock2 &param_block, const unsigned int parameter_index)
	Constructs an iterator for the given parameter index of the given parameter block.
const ParamDef &	operator* () const
	Dereferences the iterator, returning a ParamDef.
ParameterIterator &	operator++ ()
ParameterIterator	operator++ (int)
bool	operator== (const ParameterIterator &rhs) const
bool	operator!= (const ParameterIterator &rhs) const

Detailed Description

Provides standard C++ iteration functionality for the parameters stored by an IParamBlock2.

Iterator Validity

The iterator remains valid if parameters are either added or removed from the parameter block, but will continue referring to the same parameter index, and therefore may fall out of bounds in the process.

See also

IParamBlock2::begin(), IParamBlock2::end()

Constructor & Destructor Documentation

ParameterIterator()

ParameterIterator ( IParamBlock2 & param_block, const unsigned int parameter_index )

inline

Constructs an iterator for the given parameter index of the given parameter block.

    : m_param_block(&param_block),
    m_num_params(std::max(param_block.NumParams(), 0)),
    m_parameter_index(std::min(parameter_index, m_num_params))
{
}

Member Function Documentation

operator*()

const ParamDef & operator* ( ) const

inline

Dereferences the iterator, returning a ParamDef.

Like standard C++ iterators, this should not be called on out-of-bounds iterators.

{
    DbgAssert(m_parameter_index < m_num_params);
    const ParamDef* param_def = m_param_block->GetParamDefByIndex(m_parameter_index);
    // The parameter should never be null if the parameter index is valid. The caller should never try to dereference
    // this iterator if the parameter index is out of bounds.
    DbgAssert(param_def != nullptr);
    return *param_def;
}

operator++() [1/2]

IParamBlock2::ParameterIterator & operator++ ( )

inline

{
    if(DbgVerify(m_parameter_index < m_num_params))
    {
        ++m_parameter_index;
    }
    return *this;
}

operator++() [2/2]

IParamBlock2::ParameterIterator operator++ ( int )

inline

{
    ParameterIterator ret = *this;
    if(DbgVerify(m_parameter_index < m_num_params))
    {
        ++m_parameter_index;
    }
    return ret;
}

operator==()

bool operator== ( const ParameterIterator & rhs ) const

inline

{
    return (m_param_block == rhs.m_param_block) && (m_parameter_index == rhs.m_parameter_index);
}

operator!=()

bool operator!= ( const ParameterIterator & rhs ) const

inline

{
    return !(*this == rhs);
}