TranslationResult Class Reference

Encapsulates all of the possible result states for a translation operation. More...

#include <TranslationResult.h>

Public Types
enum	State { Success , Failure , Aborted }
	The possible values that a TranslationResult may take. More...

Public Member Functions
	TranslationResult ()
	Default constructor initializes state to Success. More...
	TranslationResult (const State val)
	Constructs (implicitly) from given state. More...
	operator State () const
	Implicit conversion operator to the State enum. More...

Detailed Description

Encapsulates all of the possible result states for a translation operation.

For simplicity, implementations of Translator::Translate() can return a result value by directly referencing the enum, e.g.:

Translate(...)
{
    return TranslationResult::Success;
}

Member Enumeration Documentation

State

enum State

The possible values that a TranslationResult may take.

Enumerator
Success	Translation succeeded.
Failure	Translation failed (for any reason)
Aborted	Translation has been aborted, as requested by the user or the system.

    {
        Success,
        Failure,
        Aborted
    };

Constructor & Destructor Documentation

TranslationResult() [1/2]

TranslationResult ( )

inline

Default constructor initializes state to Success.

    : m_value(Success)
{
 
}

TranslationResult() [2/2]

TranslationResult ( const State  val )

inline

Constructs (implicitly) from given state.

    : m_value(val)
{
 
}

Member Function Documentation

operator State()

operator State ( ) const

inline

Implicit conversion operator to the State enum.

{
    return m_value;
}