libsmbios_c library
Public Member Functions | Static Public Member Functions | Protected Member Functions
rbu::RbuFactory Class Referenceabstract

AbstractFactory that produces IRbuHdr objects. More...

#include <DellRbu.h>

Inheritance diagram for rbu::RbuFactory:
Inheritance graph
[legend]
Collaboration diagram for rbu::RbuFactory:
Collaboration graph
[legend]

Public Member Functions

virtual ~RbuFactory () throw ()
 
virtual IRbuHdrmakeNew (std::string filename)=0
 Create a new IRbuHdr object that the caller must delete. (NOT RECOMMENDED) More...
 
- Public Member Functions inherited from factory::IFactory
virtual ~IFactory ()
 
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 RbuFactorygetFactory ()
 Create a factory object that you can use to create IRbuHdr objects. More...
 

Protected Member Functions

 RbuFactory ()
 Use getFactory() to get a factory. More...
 
- Protected Member Functions inherited from factory::IFactory
 IFactory ()
 

Additional Inherited Members

- Public Types inherited from factory::IFactory
enum  { AutoDetectMode, UnitTestMode }
 
enum  { defaultMode = AutoDetectMode }
 

Detailed Description

AbstractFactory that produces IRbuHdr objects.

The RbuFactory class is based on the Factory design pattern. The RbuFactory is the recommended method to create IRbuHdr 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.

Constructor & Destructor Documentation

virtual rbu::RbuFactory::~RbuFactory ( ) throw ()
virtual
rbu::RbuFactory::RbuFactory ( )
protected

Use getFactory() to get a factory.

Member Function Documentation

static RbuFactory* rbu::RbuFactory::getFactory ( )
static

Create a factory object that you can use to create IRbuHdr objects.

Factory entry point: This is the method to call to get a handle to the RbuFactory. The RbuFactory is the recommended method to create IRbuHdr 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 deleted by the factory when it is reset() or destructed.

Returns
Singleton RbuFactory object pointer.
virtual IRbuHdr* rbu::RbuFactory::makeNew ( std::string  filename)
pure virtual

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

The makeNew() method returns a pointer to a newly allocated IRbuHdr 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<IRbuHdr>.

The getSingleton() method is preferred over this method.

Returns
(IRbuHdr *) – caller must delete

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