circlearcsplinecomputationresult.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

// primary contact: LAPA - secondary contact: NOBODY
#ifndef Navigation_CircleArcSplineComputationResult_H
#define Navigation_CircleArcSplineComputationResult_H

#include "gwnavruntime/base/types.h"

namespace Kaim
{

enum CircleArcSplineComputationResult
{
    CircleArcSplineComputation_NotComputed = 0, 
    CircleArcSplineComputation_Success     = 1, 
    CircleArcSplineComputation_Warning     = 2, 

    CircleArcSplineComputation_Failed_InvalidInputs                 = 1 << 2, 
    CircleArcSplineComputation_Failed_BubbleArrayBuildError         = 1 << 3, 
    CircleArcSplineComputation_Failed_StringPullerError             = 1 << 4, 
    CircleArcSplineComputation_Failed_InvalidStringPulledBubbleList = 1 << 5, 
    CircleArcSplineComputation_Failed_TurnListConstructionError     = 1 << 6, 
    CircleArcSplineComputation_Failed_TurnListRadiusAdjustmentError = 1 << 7, 
    CircleArcSplineComputation_Failed_CircleArcSplineBuildError     = 1 << 8, 
    CircleArcSplineComputation_Failed_InvalidSpline                 = 1 << 9  
};

KY_INLINE bool IsSuccessCase(         CircleArcSplineComputationResult result) { return result == CircleArcSplineComputation_Success;   }
KY_INLINE bool IsWarningCase(         CircleArcSplineComputationResult result) { return result == CircleArcSplineComputation_Warning;   }
KY_INLINE bool IsSuccessOrWarningCase(CircleArcSplineComputationResult result) { return IsSuccessCase(result) || IsWarningCase(result); }
KY_INLINE bool IsErrorCase(           CircleArcSplineComputationResult result) { return IsSuccessOrWarningCase(result) == false;        }


enum CircleArcSplineComputationWarningFlags
{
    CircleArcSplineComputation_Warning_ReleasedStartConstraint      = 1 << 0, 
    CircleArcSplineComputation_Warning_ReleasedEndConstraint        = 1 << 1, 

    CircleArcSplineComputation_Warning_RestrictedRadius             = 1 << 2, 
    CircleArcSplineComputation_Warning_SmallTurn                    = 1 << 3, 
};

KY_INLINE bool HasStartConstraintBeenReleased(KyUInt32 warningFlags) { return ((warningFlags & CircleArcSplineComputation_Warning_ReleasedStartConstraint) != 0); }
KY_INLINE bool HasEndConstraintBeenReleased(KyUInt32 warningFlags)   { return ((warningFlags & CircleArcSplineComputation_Warning_ReleasedEndConstraint) != 0); }
KY_INLINE bool HasRestrictedRadius(KyUInt32 warningFlags)            { return ((warningFlags & CircleArcSplineComputation_Warning_RestrictedRadius) != 0); }
KY_INLINE bool HasSmallTurns(KyUInt32 warningFlags)                  { return ((warningFlags & CircleArcSplineComputation_Warning_SmallTurn) != 0); }

}

#endif