Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

xcontract Namespace Reference


Detailed Description

The xContract namespace.

All types and functions are defined within this namespace in C++


Enumerations

enum  xContract_violation_type_t {
  xContract_unexpectedCondition,
  xContract_precondition_logic,
  xContract_precondition_parameters,
  xContract_postcondition_returnValue,
  xContract_postcondition_logic,
  xContract_postcondition_parameters,
  xContract_invariant_class,
  xContract_invariant_global,
  xContract_staticData,
  xContract_intermediateAssumption
}
 The possible violation types. More...

Functions

 XCONTRACT_CALL (int) xContract_isConditionVerified(xContract_violation_type_t type
 Application-defined function that determines whether a test for a given violation type at a given level should be verified.
 XCONTRACT_CALL (void) xContract_violationReport(char const *file
 Stock reporting function, invoked when a custom function is not specified.
 XCONTRACT_CALL (char const *) xContract_getViolationTypeString(xContract_violation_type_t type)
 C-style string corresponding to the given violation type.
 XCONTRACT_CALL (size_t) xContract_getViolationTypeStringLength(xContract_violation_type_t type)
 Length of the C-style string corresponding to the given violation type.


Enumeration Type Documentation

enum xContract_violation_type_t

The possible violation types.

See also:
xContract_getViolationTypeString, xContract_getViolationTypeStringLength
Enumerator:
xContract_unexpectedCondition  Indicates an unexpected condition
xContract_precondition_logic  Indicates a precondition logic violation
xContract_precondition_parameters  Indicates a precondition parameter violation
xContract_postcondition_returnValue  Indicates a postcondition return-value violation
xContract_postcondition_logic  Indicates a postcondition logic violation
xContract_postcondition_parameters  Indicates a postcondition parameter violation
xContract_invariant_class  Indicates a class invariant violation
xContract_invariant_global  Indicates a global invariant violation
xContract_staticData  Indicates that static data is in violatation
xContract_intermediateAssumption  Indicates an immediate assumption violatation


b64 Library documentation © Synesis Software Pty Ltd, 2004-2007