SqueezeBrains SDK 1.18
sb_cs::SbInfo Class Reference

Info class that wraps the sb_t_info structure.
You must call the Dispose() method to free all the resources of the returned instance. More...

#include <cs_sb.h>

Inheritance diagram for sb_cs::SbInfo:
Collaboration diagram for sb_cs::SbInfo:

Public Member Functions

SbError Refresh (int dl_devices_info)
 Refresh the sb library information More...
 
String Format ()
 Formats SbInfo parameters in a string. More...
 
- Public Member Functions inherited from sb_cs::SbCommon
SbError Error ()
 Returns the error code of the last operation. If no error SbError.SB_ERR_NONE is returned. More...
 
String ErrorMsg ()
 Returns the error message of the last operation. More...
 

Data Fields

SbVersion version
 Version of the sb library.

See also
sb_t_info.version

 
String version_str
 String of the version of the sb library.

See also
sb_t_info.version_str

 
String compile_date
 String of the compile date of the sb library.

See also
sb_t_info.compile_date

 
String compile_time
 String of the compile time of the sb library

See also
sb_t_info.compile_time

 
signed long long malloc_size
 Current allocated memory, expressed in bytes, by sb the library.

See also
sb_t_info.malloc_size

 
signed long long malloc_size_max
 Maximum allocated memory, expressed in bytes, by sb the library.

See also
sb_t_info.malloc_size_max

 
int dl_modules_enabled
 Value is different from 0 if Deep Learning modules are enabled.

See also
sb_t_info.dl_modules_enabled

 
array< SbDeviceInfo^> devices
 Array of available devices

See also
sb_t_info.devices

 

Additional Inherited Members

- Static Public Member Functions inherited from sb_cs::SbCommon
static String FormatError (SbError error)
 Returns the error message. More...
 

Detailed Description

Info class that wraps the sb_t_info structure.
You must call the Dispose() method to free all the resources of the returned instance.

Definition at line 332 of file cs_sb.h.

Member Function Documentation

◆ Format()

String sb_cs::SbInfo::Format ( )

Formats SbInfo parameters in a string.

Returns
An instance to the String class or null in case of memory error.
See also
sb_format_info

◆ Refresh()

SbError sb_cs::SbInfo::Refresh ( int  dl_devices_info)

Refresh the sb library information

Parameters
dl_devices_infoSet to a value other than 0 to also get the gpu information
Returns
If successful, returns SbError.SB_ERR_NONE. Otherwise, it returns an error code SbError.
See also
sb_get_info

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