#include <backgroundentry.h>

Inheritance diagram for BackgroundEntryInterface:

Detailed Description

BackgroundEntryInterface provides informations about a background entry. It's the base class for BackgroundProgressInterface.

Public Types
enum class	STATE { NONE , SUCCEEDED , CANCELED , WARNING , ERROR }

Public Member Functions
enum maxon::BackgroundEntryInterface::STATE	MAXON_ENUM_FLAGS_CLASS (STATE)

MAXON_METHOD String	GetName () const

MAXON_METHOD UniversalDateTime	GetStartTime () const

MAXON_METHOD TimeValue	GetDuration () const

MAXON_METHOD STATE	GetState ()

MAXON_METHOD Result< Bool >	GetStates (const ValueReceiver< STATE, const String & > &state) const

MAXON_METHOD Int	GetStateCount () const

MAXON_METHOD Result< void >	AddState (STATE state, const String &message)

Private Member Functions
	MAXON_INTERFACE (BackgroundEntryInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.backgroundentry")

Member Enumeration Documentation

◆ STATE

enum STATE

strong

Enumerator
NONE
SUCCEEDED	Background Task succeeded.
CANCELED	Background Task was canceled.
WARNING	Background Task has warnings.
ERROR	Background Task has errors.

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE	(	BackgroundEntryInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.interface.backgroundentry"
	)

private

◆ MAXON_ENUM_FLAGS_CLASS()

enum maxon::BackgroundEntryInterface::STATE MAXON_ENUM_FLAGS_CLASS ( STATE )

◆ GetName()

MAXON_METHOD String GetName ( ) const

GetName returns the name of the entry.

◆ GetStartTime()

MAXON_METHOD UniversalDateTime GetStartTime ( ) const

GetStartTime returns the time when the entry has been created (so it is the start time).

◆ GetDuration()

MAXON_METHOD TimeValue GetDuration ( ) const

GetDuration returns the duration of the entry.

◆ GetState()

MAXON_METHOD STATE GetState ( )

GetState returns the overall state of the entry. The highest level (e.g. error) defines the state.

◆ GetStates()

MAXON_METHOD Result<Bool> GetStates ( const ValueReceiver< STATE, const String & > & state ) const

GetStates iterates over all state entries and calls the value receiver for each.

Parameters

[in] state ValueReceiver which is called for every entry in the list. Return false to stop the iteration immediately.

Returns: The return value of the ValueReceiver. True if all values were iterated and the callback did not stop the iteration.

◆ GetStateCount()

MAXON_METHOD Int GetStateCount ( ) const

GetStateCount description.

Returns: OK on success.

◆ AddState()

MAXON_METHOD Result<void> AddState	(	STATE	state,
		const String &	message
	)

AddState adds a new state message to the entry.