SMBIOS Library
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SmbiosFactory Class Reference

AbstractFactory that produces ISmbiosTable objects. More...

#include <ISmbios.h>

Inheritance diagram for SmbiosFactory:
Inheritance graph
Collaboration diagram for SmbiosFactory:
Collaboration graph

Public Types

enum  { AutoDetectMode, UnitTestMode }
enum  { defaultMode = AutoDetectMode }

Public Member Functions

virtual ~SmbiosFactory () throw ()
virtual ISmbiosTablegetSingleton ()=0
 Recommended way to get an ISmbiosTable object.
virtual ISmbiosTablemakeNew ()=0
 Create a new ISmbiosTable object that the caller must delete. (NOT RECOMMENDED)
virtual void setParameter (const std::string name, const std::string value)=0
virtual void setParameter (const std::string name, const u32 value)=0
virtual void setMode (const int mode)=0
virtual void reset ()=0
virtual std::string getParameterString (const std::string name) const =0
virtual u32 getParameterNum (const std::string name) const =0
virtual int getMode () const =0

Static Public Member Functions

static SmbiosFactorygetFactory ()
 Create a factory object that you can use to create ISmbiosTable objects.

Protected Member Functions

 SmbiosFactory ()
 Use getFactory() to get a factory.

Detailed Description

AbstractFactory that produces ISmbiosTable objects.

The SmbiosFactory class is based on the Factory design pattern. The SmbiosFactory is the recommended method to create ISmbiosTable objects.

The getSingleton() is the recommended method to call to create tables. You need not delete the pointer returned by this method, it will be delete by the factory when it is reset() or destructed.

Most users of the factory need call nothing more than getFactory() and then getSingleton() on the returned factory object.

Advanced users can call setParameter() to set up internal factory variables that control creation of tables.

Definition at line 71 of file ISmbios.h.

Member Enumeration Documentation

anonymous enum
inherited
Enumerator:
AutoDetectMode 
UnitTestMode 

Definition at line 57 of file IFactory.h.

anonymous enum
inherited
Enumerator:
defaultMode 

Definition at line 58 of file IFactory.h.

Constructor & Destructor Documentation

~SmbiosFactory ( ) throw ()
virtual

Definition at line 34 of file SmbiosFactory.cpp.

SmbiosFactory ( )
protected

Use getFactory() to get a factory.

Definition at line 36 of file SmbiosFactory.cpp.

Member Function Documentation

SmbiosFactory * getFactory ( )
static
virtual int getMode ( ) const
pure virtualinherited
virtual u32 getParameterNum ( const std::string  name) const
pure virtualinherited
virtual std::string getParameterString ( const std::string  name) const
pure virtualinherited
virtual ISmbiosTable* getSingleton ( )
pure virtual
virtual ISmbiosTable* makeNew ( )
pure virtual

Create a new ISmbiosTable object that the caller must delete. (NOT RECOMMENDED)

The makeNew() method returns a pointer to a newly allocated ISmbiosTable object. The caller is responsible for deleting this reference when it is finished with it. It is recommended that the caller store the pointer in an std::auto_ptr<ISmbiosTable>.

The getSingleton() method is preferred over this method.

Returns
(ISmbiosTable *) – caller must delete

Referenced by testPlatform::testConstructionOffset2(), and testStandalone::testNonXml().

virtual void reset ( )
pure virtualinherited
virtual void setMode ( const int  mode)
pure virtualinherited
virtual void setParameter ( const std::string  name,
const std::string  value 
)
pure virtualinherited
virtual void setParameter ( const std::string  name,
const u32  value 
)
pure virtualinherited

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