Places a Parameter inside this Parameters collection, making it available for any method which gets a Parameter.
- Parameters
-
np | A Pointer to the Parameter wished to add to this Parameters collection. This method FAILs with NULL_POINTER if this argument is null, and FAILs with ILLEGAL_ARGUMENT if this Parameter has its m_next field set already. It also FAILs with DUPLICATE_ENTRY if this Parameter is already held in this Parameters collection. |
Gets the Parameter at a specified index in this Parameters collection.
- Parameters
-
index | The index of the Parameter to get from this Parameters collection. If this number is not less than the number of Parameters held by this Parameters collection, this method FAILs with ARRAY_INDEX_OUT_OF_BOUNDS . |
- Returns
- A Pointer to the Parameter held at the specified index in this Parameters collection.
Gets a mutable version of the Parameter at a specified index in this Parameters collection.
- Parameters
-
index | The index of the Parameter to get from this Parameters collection. If this number is greater than the number of Parameters held by this Parameters collection, this method FAILs with ARRAY_INDEX_OUT_OF_BOUNDS . |
- Returns
- A Pointer to the Parameter held at the specified index in this Parameters collection.
Gets the index of a specified Parameter inside this Parameters collection.
- Parameters
-
ap | The Parameter to search this Parameters collection for. This method FAILs with NULL_POINTER if this argument is NULL . |
- Returns
- The 0-based index of
ap
inside this Parameters collection, or -1
if it is not found.
template<class PARM>
s32 MFM::Parameters< PARM >::GetParameterNumberFromTag |
( |
const char * |
tag | ) |
const |
|
inline |
Gets the index of a Parameter held by this Parameters collection by specifying its Parameter Tag.
- Parameters
-
tag | The Tag of the Parameter to look up. This method FAILs with NULL_POINTER if this argument is NULL . |
- Returns
- The 0-based index of the Parameter whose tag is
tag
, or -1
if there is no such Parameter .
The documentation for this class was generated from the following file: