Error Utility

Table of Contents

• Macros
• Further Reading

Macros

These macros are used to automatically check the given condition and to return an error object if the condition is not met:

• CheckArgument : Returns an IllegalArgumentError.
• CheckState : Returns an IllegalStateError.
• CheckAssert : Returns an UnexpectedError.

See also Error Types.

// This function checks the given arguments and returns an error if they do not match.
 
//----------------------------------------------------------------------------------------
// This functions adds the values stored in the second array to the values stored in the first array.
// Both arrays must have the same size.
// @param[in, out]  arrayA  The first array. It will contain the result values.
// @param[in]       arrayB  The second array.
// @return                  maxon::OK on success.
//----------------------------------------------------------------------------------------
static maxon::Result<void> AddArrays(maxon::BaseArray<maxon::Int>& arrayA, maxon::BaseArray<maxon::Int>& arrayB)
{
  iferr_scope;
 
  // check arguments
  CheckArgument(arrayA.GetCount() == arrayB.GetCount(), "Array sizes do not match.");
 
  // add numbers
 
  const maxon::Int size = arrayA.GetCount();
 
  for (maxon::Int i = 0; i < size; ++i)
    arrayA[i] = arrayA[i] + arrayB[i];
 
  return maxon::OK;
}

Further Reading

• Error System
• Error Handling
• Error Result
• Error Class
• Error Types
• Debugging