Open Search
    Public Member Functions | Private Member Functions | List of all members
    AggregatedErrorInterface Class Reference
    System

    #include <errorbase.h>

    Inheritance diagram for AggregatedErrorInterface:
    Inheritance graph
    [legend]

    Detailed Description

    Error that contains multiple errors. This error might be returned if multiple jobs of a group return errors. The GetMessage functions retrieves the combined output of all errors.

    @MAXON_ANNOTATION{refclass=false}

    Public Member Functions

    MAXON_METHOD Bool AddError (const Error &error)
     
    MAXON_METHOD Bool AddError (Error &&error)
     
    MAXON_METHOD Int GetCount () const
     
    MAXON_METHOD const Error & GetError (Int index) const
     

    Private Member Functions

     MAXON_INTERFACE (AggregatedErrorInterface, MAXON_REFERENCE_COPY_ON_WRITE, "net.maxon.interface.aggregatederror")
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( AggregatedErrorInterface  ,
    MAXON_REFERENCE_COPY_ON_WRITE  ,
    "net.maxon.interface.aggregatederror"   
    )
    		private

    ◆ AddError() [1/2]

    MAXON_METHOD Bool AddError ( const Error &  error)

    Adds an error to this AggregatedError.

    Parameters
    [in]errorAggregatedError to add.

    ◆ AddError() [2/2]

    MAXON_METHOD Bool AddError ( Error &&  error)

    Adds an error to this AggregatedError.

    Parameters
    [in]errorAggregatedError to add.

    ◆ GetCount()

    MAXON_METHOD Int GetCount ( ) const

    Returns the number of errors in this AggregatedError.

    ◆ GetError()

    MAXON_METHOD const Error& GetError ( Int  index) const

    Returns the error at the given index.

    Parameters
    [in]indexIndex of the error. Index must be >= 0 and < GetCount().
    Returns
    Error stored at this index.