info.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_INFO_H
#define AJA_INFO_H

#include "ajabase/common/public.h"
#include <vector>
#include <map>
#include <string>

// forward declarations
class AJASystemInfoImpl;

enum AJASystemInfoMemoryUnit
{
    AJA_SystemInfoMemoryUnit_Bytes,
    AJA_SystemInfoMemoryUnit_Kilobytes,
    AJA_SystemInfoMemoryUnit_Megabytes,
    AJA_SystemInfoMemoryUnit_Gigabytes,

    AJA_SystemInfoMemoryUnit_LAST
};

enum AJASystemInfoTag
{
    AJA_SystemInfoTag_System_Model,
    AJA_SystemInfoTag_System_Bios,
    AJA_SystemInfoTag_System_Name,
    AJA_SystemInfoTag_System_BootTime,
    AJA_SystemInfoTag_OS_ProductName,
    AJA_SystemInfoTag_OS_Version,
    AJA_SystemInfoTag_OS_VersionBuild,
    AJA_SystemInfoTag_OS_KernelVersion,
    AJA_SystemInfoTag_CPU_Type,
    AJA_SystemInfoTag_CPU_NumCores,
    AJA_SystemInfoTag_Mem_Total,
    AJA_SystemInfoTag_Mem_Used,
    AJA_SystemInfoTag_Mem_Free,
    AJA_SystemInfoTag_GPU_Type,
    AJA_SystemInfoTag_Path_UserHome,
    AJA_SystemInfoTag_Path_PersistenceStoreUser,
    AJA_SystemInfoTag_Path_PersistenceStoreSystem,
    AJA_SystemInfoTag_Path_Applications,
    AJA_SystemInfoTag_Path_Utilities,
    AJA_SystemInfoTag_Path_Firmware,
    AJA_SystemInfoTag_Path_NTV2Plugins,             //  New in SDK 18.0
    AJA_SystemInfoTag_Path_NTV2VirtualDevices,      //  New in SDK 18.0

    AJA_SystemInfoTag_LAST
};

enum AJASystemInfoSections
{
    AJA_SystemInfoSection_CPU    = 0x00000001 << 0,
    AJA_SystemInfoSection_GPU    = 0x00000001 << 1,
    AJA_SystemInfoSection_Mem    = 0x00000001 << 2,
    AJA_SystemInfoSection_OS     = 0x00000001 << 3,
    AJA_SystemInfoSection_Path   = 0x00000001 << 4,
    AJA_SystemInfoSection_System = 0x00000001 << 5,

    AJA_SystemInfoSection_None   = 0x00000000,
    AJA_SystemInfoSection_All    = 0xFFFFFFFF
};

typedef std::pair<std::string, std::string>     AJALabelValuePair;              
typedef std::vector<AJALabelValuePair>          AJALabelValuePairs;             
typedef AJALabelValuePairs::const_iterator      AJALabelValuePairsConstIter;

class AJA_EXPORT AJASystemInfo
{
public: //  Instance Methods
    AJASystemInfo (const AJASystemInfoMemoryUnit inUnits = AJA_SystemInfoMemoryUnit_Megabytes,
                   AJASystemInfoSections sections = AJA_SystemInfoSection_All);

    virtual ~AJASystemInfo();

    virtual AJAStatus Rescan (AJASystemInfoSections sections = AJA_SystemInfoSection_All);
    
    virtual AJAStatus GetValue(const AJASystemInfoTag inTag, std::string & outValue) const;
    
    virtual AJAStatus GetLabel(const AJASystemInfoTag inTag, std::string & outLabel) const;

    virtual AJAStatus GetLabelValuePairs(AJALabelValuePairs &outTable, bool clearTable = false) const;

    virtual void ToString (std::string & outAllLabelsAndValues) const;

    virtual std::string ToString (const size_t inValueWrapLen = 0, const size_t inGutterWidth = 3) const;

public: //  Class Methods
    static std::string ToString (const AJALabelValuePairs & inLabelValuePairs, const size_t inValueWrapLen = 0, const size_t inGutterWidth = 3);

    static inline AJALabelValuePairs & append (AJALabelValuePairs & inOutTable, const std::string & inLabel, const std::string & inValue = std::string())
                                                {inOutTable.push_back(AJALabelValuePair(inLabel,inValue)); return inOutTable;}

private:    //  Instance Data
    AJASystemInfoImpl* mpImpl;
};


AJA_EXPORT std::ostream & operator << (std::ostream & outStream, const AJASystemInfo & inData);

AJA_EXPORT std::ostream & operator << (std::ostream & outStream, const AJALabelValuePair & inData);

AJA_EXPORT std::ostream & operator << (std::ostream & outStream, const AJALabelValuePairs & inData);

#endif  //  AJA_INFO_H