smbios Namespace Reference

Data Structures

class  IException
 Base class for all Abstract Exceptions. More...
class  SmbiosFactory
 AbstractFactory that produces ISmbiosTable objects. More...
class  ISmbiosTable
 Interface definition for Smbios Table operations. More...
class  ISmbiosItem
 Interface definition for Smbios Item operations. More...
class  SmbiosTableIteratorBase
 Iterator base class for ISmbiosTable objects. More...
class  SmbiosTableIterator
class  ConstSmbiosTableIterator
class  TokenTableFactory
class  ITokenTable
 Table interface to obtain individual Tokens. More...
class  IToken
 Interface to inspect or manipulate individual tokens. More...
class  IProtectedToken
class  ICmosToken
class  ISmiToken
class  TokenTableIteratorBase
 Base class for the TokenTableIterator subclassess. More...
class  TokenTableIterator
 Iterator for TokenTable objects. More...
class  ConstTokenTableIterator
 Iterator for const TokenTable objects. More...

Enumerations

enum  {
  BIOS_Information = 0, System_Information = 1, Base_Board_Information = 2, System_Enclosure_or_Chassis = 3,
  Processor_Information = 4, Memory_Controller_Information = 5, Memory_Module_Information = 6, Cache_Information = 7,
  Port_Connector_Information = 8, System_Slots = 9, On_Board_Devices_Information = 10, OEM_Strings = 11,
  System_Configuration_Options = 12, BIOS_Language_Information = 13, Group_Associations = 14, System_Event_Log = 15,
  Physical_Memory_Array = 16, Memory_Device = 17, Memory_Error_Information_32_bit = 18, Memory_Array_Mapped_Address = 19,
  Memory_Device_Mapped_Address = 20, Built_in_Pointing_Device = 21, Portable_Battery = 22, System_Reset = 23,
  Hardware_Security = 24, System_Power_Controls = 25, Voltage_Probe = 26, Cooling_Device = 27,
  Temperature_Probe = 28, Electrical__Current_Probe = 29, Out_of_Band_Remote_Access = 30, Boot_Integrity_Services_Entry_Point = 31,
  System_Boot_Information = 32, Memory_Error_Information_64_bit = 33, Management_Device = 34, Management_Device_Component = 35,
  Management_Device_Threshold = 36, Memory_Channel = 37, IPMI_Device_Information = 38, System_Power_Supply = 39,
  Inactive = 126, Revisions_and_IDs = 208, Parallel_Port = 209, Serial_Port = 210,
  IR_Port = 211, End_of_Table = 127, Dell_Revisions_and_IDs = 0xD0, Dell_Indexed_Io = 0xD4
}

Functions

 DECLARE_EXCEPTION (NotImplemented)
 DECLARE_EXCEPTION (InternalError)
 DECLARE_EXCEPTION (PermissionException)
 DECLARE_EXCEPTION (SmbiosException)
 DECLARE_EXCEPTION_EX (ParameterException, smbios, SmbiosException)
 DECLARE_EXCEPTION_EX (ParseException, smbios, SmbiosException)
 DECLARE_EXCEPTION_EX (StringUnavailable, smbios, SmbiosException)
 DECLARE_EXCEPTION_EX (DataOutOfBounds, smbios, SmbiosException)
 DECLARE_EXCEPTION_EX (ItemNotFound, smbios, SmbiosException)
u8 getItemType (const ISmbiosItem &item)
u8 getItemLength (const ISmbiosItem &item)
u16 getItemHandle (const ISmbiosItem &item)
u8 getU8_FromItem (const ISmbiosItem &item, unsigned int offset)
u16 getU16_FromItem (const ISmbiosItem &item, unsigned int offset)
u32 getU32_FromItem (const ISmbiosItem &item, unsigned int offset)
u64 getU64_FromItem (const ISmbiosItem &item, unsigned int offset)
const char * getString_FromItem (const ISmbiosItem &item, unsigned int offset)
void * getBits_FromItem (const ISmbiosItem &item, unsigned int offset, void *out, unsigned int lsb=0, unsigned int msb=0)
bool isBitSet (const ISmbiosItem *itemPtr, unsigned int offset, unsigned int bitToTest)
template<class R >
R & getData (const ISmbiosItem &item, unsigned int offset, R &out)
std::ostream & operator<< (std::ostream &cout, const ISmbiosTable &item)
std::ostream & operator<< (std::ostream &cout, const ISmbiosItem &item)
 DECLARE_EXCEPTION (TokenException)
 DECLARE_EXCEPTION_EX (InvalidTokenTableMode, smbios, TokenException)
 DECLARE_EXCEPTION_EX (InvalidAccessMode, smbios, TokenException)
 DECLARE_EXCEPTION_EX (DerefNullPointer, smbios, TokenException)
 DECLARE_EXCEPTION_EX (ParameterError, smbios, TokenException)
 DECLARE_EXCEPTION_EX (InvalidChecksum, smbios, TokenException)
 DECLARE_EXCEPTION_EX (NeedAuthentication, smbios, TokenException)
std::ostream & operator<< (std::ostream &cout, const ITokenTable &item)
std::ostream & operator<< (std::ostream &cout, const IToken &item)
bool isTokenActive (int tokenNum)
void activateToken (int tokenNum, std::string password="")

Enumeration Type Documentation

anonymous enum
Enumerator:
BIOS_Information 
System_Information 
Base_Board_Information 
System_Enclosure_or_Chassis 
Processor_Information 
Memory_Controller_Information 
Memory_Module_Information 
Cache_Information 
Port_Connector_Information 
System_Slots 
On_Board_Devices_Information 
OEM_Strings 
System_Configuration_Options 
BIOS_Language_Information 
Group_Associations 
System_Event_Log 
Physical_Memory_Array 
Memory_Device 
Memory_Error_Information_32_bit 
Memory_Array_Mapped_Address 
Memory_Device_Mapped_Address 
Built_in_Pointing_Device 
Portable_Battery 
System_Reset 
Hardware_Security 
System_Power_Controls 
Voltage_Probe 
Cooling_Device 
Temperature_Probe 
Electrical__Current_Probe 
Out_of_Band_Remote_Access 
Boot_Integrity_Services_Entry_Point 
System_Boot_Information 
Memory_Error_Information_64_bit 
Management_Device 
Management_Device_Component 
Management_Device_Threshold 
Memory_Channel 
IPMI_Device_Information 
System_Power_Supply 
Inactive 
Revisions_and_IDs 
Parallel_Port 
Serial_Port 
IR_Port 
End_of_Table 
Dell_Revisions_and_IDs 
Dell_Indexed_Io 

Function Documentation

void smbios::activateToken ( int  tokenNum,
std::string  password = "" 
)
smbios::DECLARE_EXCEPTION ( TokenException   ) 
smbios::DECLARE_EXCEPTION ( SmbiosException   ) 
smbios::DECLARE_EXCEPTION ( PermissionException   ) 

Used in cases where operating system privleges prevent an action.

smbios::DECLARE_EXCEPTION ( InternalError   ) 

Used in cases where something that "cannot happen" happens. Raised in instances usually caused by some internal class state becoming corrupted.

smbios::DECLARE_EXCEPTION ( NotImplemented   ) 

Raised when some class does not implement part of the public interface Used mainly in classes where there are optional parts of the interface defined that require extra external functionality, such as XML, for example.

smbios::DECLARE_EXCEPTION_EX ( NeedAuthentication  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( InvalidChecksum  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( ParameterError  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( DerefNullPointer  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( InvalidAccessMode  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( InvalidTokenTableMode  ,
smbios  ,
TokenException   
)
smbios::DECLARE_EXCEPTION_EX ( ItemNotFound  ,
smbios  ,
SmbiosException   
)
smbios::DECLARE_EXCEPTION_EX ( DataOutOfBounds  ,
smbios  ,
SmbiosException   
)
smbios::DECLARE_EXCEPTION_EX ( StringUnavailable  ,
smbios  ,
SmbiosException   
)
smbios::DECLARE_EXCEPTION_EX ( ParseException  ,
smbios  ,
SmbiosException   
)
smbios::DECLARE_EXCEPTION_EX ( ParameterException  ,
smbios  ,
SmbiosException   
)
void* smbios::getBits_FromItem ( const ISmbiosItem &  item,
unsigned int  offset,
void *  out,
unsigned int  lsb = 0,
unsigned int  msb = 0 
)
template<class R >
R& smbios::getData ( const ISmbiosItem &  item,
unsigned int  offset,
R &  out 
) [inline]
u16 smbios::getItemHandle ( const ISmbiosItem &  item  ) 
u8 smbios::getItemLength ( const ISmbiosItem &  item  ) 
u8 smbios::getItemType ( const ISmbiosItem &  item  ) 
const char* smbios::getString_FromItem ( const ISmbiosItem &  item,
unsigned int  offset 
)
u16 smbios::getU16_FromItem ( const ISmbiosItem &  item,
unsigned int  offset 
)
u32 smbios::getU32_FromItem ( const ISmbiosItem &  item,
unsigned int  offset 
)
u64 smbios::getU64_FromItem ( const ISmbiosItem &  item,
unsigned int  offset 
)
u8 smbios::getU8_FromItem ( const ISmbiosItem &  item,
unsigned int  offset 
)
bool smbios::isBitSet ( const ISmbiosItem *  itemPtr,
unsigned int  offset,
unsigned int  bitToTest 
)
bool smbios::isTokenActive ( int  tokenNum  ) 
std::ostream& smbios::operator<< ( std::ostream &  cout,
const IToken &  item 
)
std::ostream& smbios::operator<< ( std::ostream &  cout,
const ITokenTable &  item 
)
std::ostream& smbios::operator<< ( std::ostream &  cout,
const ISmbiosItem &  item 
)
std::ostream& smbios::operator<< ( std::ostream &  cout,
const ISmbiosTable &  item 
)
Generated on Wed Jul 28 08:16:09 2010 for libsmbios_c library by  doxygen 1.6.3