info.h File Reference

Declares the AJASystemInfo class. More...

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

Include dependency graph for info.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	AJASystemInfo

Typedefs
typedef std::pair< std::string, std::string >	AJALabelValuePair
	A pair of strings comprising a label and a value. More...
typedef std::vector< AJALabelValuePair >	AJALabelValuePairs
	An ordered sequence of label/value pairs. More...
typedef AJALabelValuePairs::const_iterator	AJALabelValuePairsConstIter

Enumerations
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_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 }

Functions
AJA_EXPORT std::ostream &	operator<< (std::ostream &outStream, const AJASystemInfo &inData)
	Streams a human-readable representation of the AJASystemInfo into the given output stream. More...
AJA_EXPORT std::ostream &	operator<< (std::ostream &outStream, const AJALabelValuePair &inData)
	Streams a human-readable representation of the AJALabelValuePair into the given output stream. More...
AJA_EXPORT std::ostream &	operator<< (std::ostream &outStream, const AJALabelValuePairs &inData)
	Streams a human-readable representation of the AJALabelValuePairs into the given output stream. More...

Detailed Description

Declares the AJASystemInfo class.

Copyright

(C) 2009-2022 AJA Video Systems, Inc. All rights reserved.

Definition in file info.h.

Typedef Documentation

AJALabelValuePair

typedef std::pair<std::string, std::string> AJALabelValuePair

A pair of strings comprising a label and a value.

Definition at line 68 of file info.h.

AJALabelValuePairs

typedef std::vector<AJALabelValuePair> AJALabelValuePairs

An ordered sequence of label/value pairs.

Definition at line 69 of file info.h.

AJALabelValuePairsConstIter

typedef AJALabelValuePairs::const_iterator AJALabelValuePairsConstIter

Definition at line 70 of file info.h.

Enumeration Type Documentation

AJASystemInfoMemoryUnit

enum AJASystemInfoMemoryUnit

Enumerator
AJA_SystemInfoMemoryUnit_Bytes
AJA_SystemInfoMemoryUnit_Kilobytes
AJA_SystemInfoMemoryUnit_Megabytes
AJA_SystemInfoMemoryUnit_Gigabytes
AJA_SystemInfoMemoryUnit_LAST

Definition at line 19 of file info.h.

AJASystemInfoSections

enum AJASystemInfoSections

Enumerator
AJA_SystemInfoSection_CPU
AJA_SystemInfoSection_GPU
AJA_SystemInfoSection_Mem
AJA_SystemInfoSection_OS
AJA_SystemInfoSection_Path
AJA_SystemInfoSection_System
AJA_SystemInfoSection_None
AJA_SystemInfoSection_All

Definition at line 55 of file info.h.

AJASystemInfoTag

enum AJASystemInfoTag

Enumerator
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_LAST

Definition at line 29 of file info.h.

Function Documentation

operator<<() [1/3]

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

Streams a human-readable representation of the AJALabelValuePair into the given output stream.

Parameters

	outStream	The stream into which the given AJALabelValuePair will be printed.
[in]	inData	The AJALabelValuePair to be streamed.

Returns

A reference to the given "outStream".

operator<<() [2/3]

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

Streams a human-readable representation of the AJALabelValuePairs into the given output stream.

Parameters

	outStream	The stream into which the given AJALabelValuePairs will be printed.
[in]	inData	The AJALabelValuePairs to be streamed.

Returns

A reference to the given "outStream".

operator<<() [3/3]

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

Streams a human-readable representation of the AJASystemInfo into the given output stream.

Parameters

	outStream	The stream into which the given AJASystemInfo will be printed.
[in]	inData	The AJASystemInfo to be streamed.

Returns

A reference to the given "outStream".