splineinputblobdumper.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once

#include "gwnavruntime/pathfollower/circlearcsplinecomputationresult.h"
#include "gwnavruntime/math/vec3f.h"
#include "gwnavruntime/containers/stringstream.h"
#include "gwnavruntime/kernel/SF_RefCount.h"

namespace Kaim
{

class CircleArcSplineComputer;
class StringStream;


// Internal: Class that configure a case tracker that save CircleArcSplineComputer
// inputs into a blob under specified conditions. This class is useful to track
// down mishandled edge cases.
class SplineInputBlobDumpConfig: public RefCountBase<SplineInputBlobDumpConfig, Stat_Debug_Mem>
{
public:
    SplineInputBlobDumpConfig()
        : m_baseName("CircleArcSplineComputerInput")
        , m_trackedResultFlags(DumpAllFailureCases)
        , m_trackedWarningFlags(0)
        , m_maxSavedCase(50)
        , m_minSqDistToLastSaved(0.1f)
        , m_registredSavedCaseCount(0)
    {}

    bool DoTrackAnyCase() const { return (m_trackedResultFlags != 0); }

    bool IsATrackedResult(CircleArcSplineComputationResult result, KyUInt32 warningFlags) const
    {
        if ((m_trackedResultFlags & result) != 0)
            return true;
        return ((warningFlags & m_trackedWarningFlags) != 0);
    }

    static const KyUInt32 DumpAllFailureCases =
        CircleArcSplineComputation_Failed_InvalidInputs                 |
        CircleArcSplineComputation_Failed_BubbleArrayBuildError         |
        CircleArcSplineComputation_Failed_StringPullerError             |
        CircleArcSplineComputation_Failed_InvalidStringPulledBubbleList |
        CircleArcSplineComputation_Failed_TurnListConstructionError     |
        CircleArcSplineComputation_Failed_TurnListRadiusAdjustmentError |
        CircleArcSplineComputation_Failed_CircleArcSplineBuildError     ;

public: // internal
    // Internal: called only by the dumper itself to update saved case count
    // and its start position.
    void RegisterSavedCase(const Vec3f& savedCaseStartPos);
    void GetCaseBlobName(StringStream& fileName) const;
    bool IsCaseSaveAllowed(const Vec3f& caseStartPos) const;

public:
    const char* m_baseName;
    KyUInt32 m_trackedResultFlags;
    KyUInt32 m_trackedWarningFlags;
    KyUInt32 m_maxSavedCase;
    KyFloat32 m_minSqDistToLastSaved;

private:
    Vec3f m_lastSavedCaseStartPos;
    KyUInt32 m_registredSavedCaseCount;
};


class SplineInputBlobDumper
{
public:
    SplineInputBlobDumper(CircleArcSplineComputer* computer, Ptr<SplineInputBlobDumpConfig> config)
        : m_computer(computer)
        , m_config(config)
        , m_saveBlobAtDestruction(false)
    {
        if (m_config)
            m_saveBlobAtDestruction = m_config->DoTrackAnyCase();
    }

    ~SplineInputBlobDumper()
    {
        if (m_saveBlobAtDestruction)
            SaveBlob();
    }

    KyResult SaveBlob();

public:
    CircleArcSplineComputer* m_computer;
    Ptr<SplineInputBlobDumpConfig> m_config;
    bool m_saveBlobAtDestruction;
};

} // namespace Kaim