IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Attributes | List of all members
ipsdk::hard::CpuDescription Class Reference

Description associated to a cpu resource. More...

#include <CpuDescription.h>

Inheritance diagram for ipsdk::hard::CpuDescription:
ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

bool isInit () const
 recovery of object initialization flag
 
void init (const std::string &cpuShortInfoString, const std::string &cpuBrandInfoString, ipUInt32 nbPhysicalCores, bool bSupportHyperThreading, const InstructionSetColl &instructionSetColl, const ipUInt64 &totalPhysMem)
 initialization of object data
 
const std::string & getCpuShortInfoString () const
 retrieve cpu short info string More...
 
const std::string & getCpuBrandInfoString () const
 retrieve cpu brand info string More...
 
ipUInt32 getNbPhysicalCores () const
 retrieve number of physical cores More...
 
ipUInt32 getNbLogicalCores () const
 retrieve number of logical cores More...
 
bool isHyperThreadingSupported () const
 retrieve flag indicating whether cpu support hyper-threading technology More...
 
const InstructionSetCollgetInstructionSetColl () const
 retrieve instruction set collection supported by processor More...
 
ipUInt64 getTotalPhysicalMemory () const
 retrieve total quantity of physical memory (RAM), in bytes More...
 
bool isAvailable (const eInstructionSet &instructionSet) const
 check for instruction set availability for processor More...
 
void clear ()
 clear object data
 
Constructors and destructors
 CpuDescription ()
 
 ~CpuDescription ()
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Protected Attributes

std::string _cpuShortInfoString
 cpu short info string
 
std::string _cpuBrandInfoString
 cpu brand info string
 
ipUInt32 _nbPhysicalCores
 number of cores
 
bool _bSupportHyperThreading
 flag indicating whether cpu support hyper-threading technology
 
InstructionSetColl _instructionSetColl
 instruction set collection supported by processor
 
ipUInt64 _totalPhysMem
 total physical memory (RAM), in bytes
 
bool _bInit
 object initialization flag
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

Description associated to a cpu resource.

Author
E. Noirfalise
Date
2013/4/2

Member Function Documentation

◆ getCpuShortInfoString()

const std::string& ipsdk::hard::CpuDescription::getCpuShortInfoString ( ) const

retrieve cpu short info string

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getCpuBrandInfoString()

const std::string& ipsdk::hard::CpuDescription::getCpuBrandInfoString ( ) const

retrieve cpu brand info string

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getNbPhysicalCores()

ipUInt32 ipsdk::hard::CpuDescription::getNbPhysicalCores ( ) const

retrieve number of physical cores

Note
this method return number of physical cores, hyperthreaded logical units are not taken into account
Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getNbLogicalCores()

ipUInt32 ipsdk::hard::CpuDescription::getNbLogicalCores ( ) const

retrieve number of logical cores

Note
this method return number of logical cores, hyperthreaded logical units are taken into account
Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ isHyperThreadingSupported()

bool ipsdk::hard::CpuDescription::isHyperThreadingSupported ( ) const

retrieve flag indicating whether cpu support hyper-threading technology

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getInstructionSetColl()

const InstructionSetColl& ipsdk::hard::CpuDescription::getInstructionSetColl ( ) const

retrieve instruction set collection supported by processor

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ getTotalPhysicalMemory()

ipUInt64 ipsdk::hard::CpuDescription::getTotalPhysicalMemory ( ) const

retrieve total quantity of physical memory (RAM), in bytes

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

◆ isAvailable()

bool ipsdk::hard::CpuDescription::isAvailable ( const eInstructionSet instructionSet) const

check for instruction set availability for processor

Exceptions
ipsdk::hard::IPSDKHardwareExceptionif isInit() == false

The documentation for this class was generated from the following file: