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

Description associated to a computer resource. More...

#include <ComputerDescription.h>

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

Public Member Functions

bool isInit () const
 recovery of object initialization flag
 
BoolResult initFromLocal ()
 initialization of object data from local machine informations More...
 
const std::string & getHostName () const
 retrieve host name More...
 
const NetworkAdapterCollgetNetworkAdapterColl () const
 retrieve network adapters More...
 
const CpuDescriptiongetCpuDescription () const
 retrieve cpu description More...
 
Constructors and destructors
 ComputerDescription ()
 
 ~ComputerDescription ()
 
- 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
 
std::string _hostName
 computer host name
 
NetworkAdapterColl _networkAdapterColl
 collection of network adapters
 
CpuDescription _cpuDescription
 cpu description
 
GpuDescription _gpuDescription
 gpu description
 
bool _bInit
 object initialization flag
 
const GpuDescription & getGpuDescriptionConst () const
 retrieve gpu description More...
 
GpuDescription & getGpuDescription ()
 computer host name
 
const ipsdk::BoolResult activateGpuSupport ()
 activates GPU support More...
 
const ipsdk::BoolResult deactivateGpuSupport ()
 activates GPU support More...
 
void clear ()
 clear of object data
 

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 computer resource.

Author
E. Noirfalise
Date
2013/3/27

Member Function Documentation

◆ initFromLocal()

BoolResult ipsdk::hard::ComputerDescription::initFromLocal ( )

initialization of object data from local machine informations

Returns
false in case of failure

◆ getHostName()

const std::string& ipsdk::hard::ComputerDescription::getHostName ( ) const

retrieve host name

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

◆ getNetworkAdapterColl()

const NetworkAdapterColl& ipsdk::hard::ComputerDescription::getNetworkAdapterColl ( ) const

retrieve network adapters

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

◆ getCpuDescription()

const CpuDescription& ipsdk::hard::ComputerDescription::getCpuDescription ( ) const

retrieve cpu description

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

◆ getGpuDescriptionConst()

const GpuDescription& ipsdk::hard::ComputerDescription::getGpuDescriptionConst ( ) const

retrieve gpu description

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

◆ activateGpuSupport()

const ipsdk::BoolResult ipsdk::hard::ComputerDescription::activateGpuSupport ( )

activates GPU support

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

◆ deactivateGpuSupport()

const ipsdk::BoolResult ipsdk::hard::ComputerDescription::deactivateGpuSupport ( )

activates GPU support

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

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