ntv2supportlogger.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef NTV2SUPPORTLOGGER_H
#define NTV2SUPPORTLOGGER_H
 
#include "ntv2card.h"
#include <map>
#include <string>
#include "ntv2utils.h"
 
typedef enum
{
    NTV2_SupportLoggerSectionInfo           = 0x00000001 << 0,
    NTV2_SupportLoggerSectionAutoCirculate  = 0x00000001 << 1,
    NTV2_SupportLoggerSectionAudio          = 0x00000001 << 2,
    NTV2_SupportLoggerSectionRouting        = 0x00000001 << 3,
    NTV2_SupportLoggerSectionRegisters      = 0x00000001 << 4,
    NTV2_SupportLoggerSectionsAll           = 0xFFFFFFFF
} NTV2SupportLoggerSections;
 
class AJAExport CNTV2SupportLogger
{
public:
    CNTV2SupportLogger (CNTV2Card & card,
                        NTV2SupportLoggerSections sections = NTV2_SupportLoggerSectionsAll);
 
    CNTV2SupportLogger (UWord cardIndex = 0,
                        NTV2SupportLoggerSections sections = NTV2_SupportLoggerSectionsAll);
 
    virtual             ~CNTV2SupportLogger (); 
 
    static int          Version             (void); 
 
    virtual void        PrependToSection    (uint32_t section, const std::string & sectionData);
 
    virtual void        AppendToSection     (uint32_t section, const std::string & sectionData);
 
    virtual void        AddHeader           (const std::string & sectionName, const std::string & sectionData);
 
    virtual void        AddFooter           (const std::string & sectionName, const std::string & sectionData);
 
    virtual std::string ToString            (void) const;   
 
    virtual void        ToString            (std::string & outString) const;
 
    virtual bool        LoadFromLog         (const std::string & inLogFilePath, const bool bForceLoad);
 
 
private:
    void    FetchInfoLog            (std::ostringstream& oss) const;
    void    FetchRegisterLog        (std::ostringstream& oss) const;
    void    FetchAutoCirculateLog   (std::ostringstream& oss) const;
    void    FetchAudioLog           (std::ostringstream& oss) const;
    void    FetchRoutingLog         (std::ostringstream& oss) const;
 
private:
    CNTV2Card &                     mDevice;
    bool                            mDispose;
    NTV2SupportLoggerSections       mSections;
    std::string                     mHeaderStr;
    std::string                     mFooterStr;
    std::map<uint32_t, std::string> mPrependMap;
    std::map<uint32_t, std::string> mAppendMap;
 
public:
    static std::string  InventLogFilePathAndName (CNTV2Card & inDevice,
                                                    std::string inPrefix = "aja_supportlog",
                                                    std::string inExtension = "log");   //  New in SDK 16.0
    static bool         DumpDeviceSDRAM (CNTV2Card & inDevice,
                                        const std::string & inFilePath,
                                        std::ostream & msgStream);  //  New in SDK 16.0
};  //  CNTV2SupportLogger
 
 
AJAExport std::ostream & operator << (std::ostream & outStream, const CNTV2SupportLogger & inData);
 
#endif // NTV2SUPPORTLOGGER_H