ipsdk::hard Namespace Reference

Namespace agregating IPSDK hardware and system management execution routines and classes. More...

Classes
class	ComputerDescription
	Description associated to a computer resource. More...
class	CpuDescription
	Description associated to a cpu resource. More...
class	IPSDKHardwareException
	Exception class for library IPSDKHardware. More...
class	MacAddress
	Structure encapsulating a network adapter mac address. More...
class	NetworkAdapterDescription
	Description associated to a network adapter resource. More...

Typedefs
typedef std::vector< std::string >	DiskSerialNumberColl
typedef boost::shared_ptr< NetworkAdapterDescription >	NetworkAdapterDescriptionPtr
	shared pointer for a network adpater description
typedef boost::shared_ptr< const NetworkAdapterDescription >	NetworkAdapterDescriptionConstPtr
	shared pointer for a const network adpater description
typedef std::vector< NetworkAdapterDescriptionPtr >	NetworkAdapterColl
	collection of network adpater description

Enumerations
enum	eIPSDKHardwareMessage {   eComputerDescNotInit, eCantInitLocalComputerDesc, eCantGetLocalHostName, eWarnDiskInitCOM,   eDiskInitCOM, eWarnDiskInitSecurity, eDiskInitSecurity, eDiskFailCreatingLocator,   eDiskConnectNullLocator, eDiskFailConnect, eDiskConnectionSucceeded, eDiskFailSetProxyBanket,   eDiskFailDiskInfoQuery, eDiskFailUdevCreation, eDiskFailStat, eDiskFailOpenDevice,   eEmptyDiskSerialNumber, eDiskSerialNumberNoInit, eDiskFailListDrives, eEmptyMacAddress,   eMacAddressNotInit, eNetworkAdapterNotInit, eNetworkAdapterInfoFailed, eIpV4AddressTypeMismatch,   eIpV6AddressTypeMismatch, eIpV4MultipleAddresses, eIpV6MultipleAddresses, eIpV4NoAddressFound,   eIpV6NoAddressFound, eAdapterNoIpAddressFound, eNoAdapterFound, eCantGetMacAddress,   eCpuDescriptionNotInit, eCantGetCPUBrandInfoString, eCantGetNumberOfCores, eUnknownProcessorType,   eErrorAllocatingIPAddresses, eNoDeviceFound, eErrorExecutingShellCommand, eBadMacHardwareNumber }
	Enumerate describing messages. More...

Functions
IPSDKHARDWARE_API BoolResult	getCpuDescriptionFromLocal (CpuDescription &cpuDescription)
	recovery of cpu description from local machine More...
IPSDKHARDWARE_API DiskSerialNumberColl	getDiskSerialNumberCollFromLocal ()
IPSDKHARDWARE_API ipsdk::BoolResult	getGpuDescriptionFromLocal (GpuDescription &gpuDescription)
	recovery of gpu description from local machine More...
IPSDKHARDWARE_API const std::string &	getIPSDKHardwareLoggerName ()
	Recovery of logger name associated to library.
IPSDKHARDWARE_API log4cplus::Logger &	getIPSDKHardwareLogger ()
	Recovery of logger associated to library.
IPSDKHARDWARE_API const LogMessageManager &	getIPSDKHardwareLogMessageManager ()
	Recovery of message manager associated to library.
IPSDKHARDWARE_API BoolResult	getNetworkAdapterCollFromLocal (NetworkAdapterColl &coll, const bool bInfinibandMacAddr=false)
	recovery of network adapter description collection from local machine

Detailed Description

Namespace agregating IPSDK hardware and system management execution routines and classes.

Enumeration Type Documentation

eIPSDKHardwareMessage

enum ipsdk::hard::eIPSDKHardwareMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eComputerDescNotInit	Computer description has not been initialized, can't access its data.
eCantInitLocalComputerDesc	Can't initialize local computer description : s.
eCantGetLocalHostName	Can't retrieve local host name.
eWarnDiskInitCOM	COM library initialization : s.
eDiskInitCOM	Failed to initialize COM library. Error code = 0x%08x: s.
eWarnDiskInitSecurity	Security initializatoin ignored : s.
eDiskInitSecurity	Failed to initialize security. Error code = 0x%08x: s.
eDiskFailCreatingLocator	Failed to create IWbemLocator object. Error code = 0x%08x.
eDiskConnectNullLocator	Could not connect to the root/cimv2 namespace: Null locator.
eDiskFailConnect	Could not connect to the root/cimv2 namespace. Error code = 0x%08x.
eDiskConnectionSucceeded	Connected to ROOT\CIMV2 WMI namespace.
eDiskFailSetProxyBanket	Could not set proxy blanket. Error code = 0x%08x.
eDiskFailDiskInfoQuery	Query for disk info failed. Error code = 0x%08x.
eDiskFailUdevCreation	Failed to create udev.
eDiskFailStat	could not get stats for drive s (returned code d)
eDiskFailOpenDevice	Failed to open s.
eEmptyDiskSerialNumber	Can't initialize disk serial number with empty value.
eDiskSerialNumberNoInit	Disk serial number has not been initialized, can't access its data.
eDiskFailListDrives	Unable to list the local drives letters.
eEmptyMacAddress	Can't initialize mac address with empty value.
eMacAddressNotInit	Mac address has not been initialized, call init before use.
eNetworkAdapterNotInit	Network adapter has not been initialized, can't access its data.
eNetworkAdapterInfoFailed	Failed to retrieve network adapter informations.
eIpV4AddressTypeMismatch	Mismatch between expected ip v4 address type and retrieved ip address type for adapter s.
eIpV6AddressTypeMismatch	Mismatch between expected ip v6 address type and retrieved ip address type for adapter s.
eIpV4MultipleAddresses	Multiple ip v4 addresses found for network adapter s.
eIpV6MultipleAddresses	Multiple ip v6 addresses found for network adapter s.
eIpV4NoAddressFound	No ip v4 address found for network adapter s.
eIpV6NoAddressFound	No ip v6 address found for network adapter s.
eAdapterNoIpAddressFound	No ip address found for network adapter s.
eNoAdapterFound	No network adapter found for local computer.
eCantGetMacAddress	Can't get mac address for network adapter s.
eCpuDescriptionNotInit	Cpu description has not been initialized, can't access its data.
eCantGetCPUBrandInfoString	Can't retrieve cpu brand information string for cpu s.
eCantGetNumberOfCores	Can't retrieve number of cores for cpu s : s.
eUnknownProcessorType	Unknown processor type s, can't get number of physical cores.
eErrorAllocatingIPAddresses	Can't allocate buffer to read IP information.
eErrorExecutingShellCommand	No device found Could not execute the shell command s
eBadMacHardwareNumber	The number of infiniband MAC addresses (ld) and hardware names (ld) does not match.

Function Documentation

getCpuDescriptionFromLocal()

IPSDKHARDWARE_API BoolResult ipsdk::hard::getCpuDescriptionFromLocal

(

CpuDescription &

cpuDescription

)

recovery of cpu description from local machine

Returns

false in case of failure

getGpuDescriptionFromLocal()

IPSDKHARDWARE_API ipsdk::BoolResult ipsdk::hard::getGpuDescriptionFromLocal

(

GpuDescription &

gpuDescription

)

recovery of gpu description from local machine

Returns

false in case of failure