Octane v1.01.20 - The Open Compression Toolkit for C++

http://octane.sourceforge.net/

CompressorManager Class Reference
[Core]

#include <compressormanager.hpp>

Inheritance diagram for CompressorManager:

List of all members.

---

Detailed Description

The CompressorManager classes holds a collection of Compressor derived classes and is used for runtime selection of which algorithm to test.

Definition at line 38 of file compressormanager.hpp.

Public Member Functions
	CompressorManager ()
	Constructor.
	~CompressorManager ()
	Destructor.
int	GetBaseCompressorCount ()
	accessor for instantiated compressor vector size
int	GetInstantiatedCompressorCount ()
	accessor for instantiated compressor vector size
OctaneCompressor *	GetBaseCompressorp (int index)
	accessor for instantiated compressor vector
OctaneCompressor *	GetInstantiatedCompressorp (int index)
	accessor for instantiated compressor vector
OctaneCompressor *	FindBaseCompressorClass (const std::string &compressorname)
	Find a base compressor for subsequent operations.
OctaneCompressor *	FindInstantiatedCompressorpFromStringId (std::string idstring)
	Find the pointer to the instantiated compressor referred to by idstring idstring can be [$name|$num|G$guid].
OctaneCompressor *	FindInstantiatedCompressorpFromGuid (unsigned short int guidindex)
	Find the pointer to the instantiated compressor referred to by a guid.
void	RegisterBaseCompressor (OctaneCompressor *compressorp)
	Register a new compressor.
void	UnRegisterBaseCompressor (OctaneCompressor *compressorp)
	Unregister a new compressor.
void	Initialize ()
	Initialize the compressdecompress manager before using it.
void	DeInitialize ()
	Deinitialize the compressdecompress manager when done with it.
OctaneCompressor *	CreateCompressorFromSavedStream (bitreader &from)
	Create a new compressor based on file info and load state.
bool	AddCompressor (OctaneCompressor *compressorp)
	Add an instantiated compressor to our instantiated list.
bool	DeleteCompressor (OctaneCompressor *compressorp)
	Delete an instantiated compressor to our instantiated list.
Protected Attributes
std::vector< OctaneCompressor * >	compressorvector_basetypes
	Vector holding the registered base compressor types.
std::vector< OctaneCompressor * >	compressorvector_instantiated
	Vector holding the registered compressors.

---

Member Function Documentation

OctaneCompressor * CompressorManager::FindBaseCompressorClass (  const std::string &  compressorname  )

Find a base compressor for subsequent operations. Returns: true on success. Definition at line 96 of file compressormanager.cpp. References compressorvector_basetypes. Referenced by CreateCompressorFromSavedStream(), and OctaneTester::RunCommand_CreateCompressor(). { // remove a compressor from our list of registered components. // you don't have to call this on exit of the program, only if you are for some reason // removing compressors during the execution of the program. vector<OctaneCompressor*>::iterator index; for (index=compressorvector_basetypes.begin();index!=compressorvector_basetypes.end();++index) { if ((*index)->GetClassName()==compressorname) return (*index); } return NULL; }

OctaneCompressor * CompressorManager::FindInstantiatedCompressorpFromStringId (  std::string  idstring  )

Find the pointer to the instantiated compressor referred to by idstring idstring can be [$name|$num|G$guid]. Returns: NULL if not found Definition at line 193 of file compressormanager.cpp. References compressorvector_instantiated. Referenced by OctaneTester::RunCommand_DeleteCompressor(), and OctaneTester::SelectInstantiatedCompressor(). { // look up a compressor based on different strings if (idstring=="") return NULL; // there are 3 ways to specify an instantiated compressor OctaneCompressor* compressorp=NULL; int indexnum; indexnum = atoi(idstring.c_str()); if (indexnum>0 || idstring=="0") { // user gave us an index if (indexnum<0 || (unsigned int)indexnum>=compressorvector_instantiated.size()) return NULL; compressorp=compressorvector_instantiated[indexnum]; return compressorp; } // ok its either a full name or a guid // first we try to look it up by name vector<OctaneCompressor*>::iterator index; for (index=compressorvector_instantiated.begin();index!=compressorvector_instantiated.end();++index) { if ((*index)->GetInstantiatedName()==idstring) return (*index); } // we didn't find it, so try to check its guid if (idstring[0]!='g' && idstring[0]!='G') return NULL; idstring=idstring.substr(1,idstring.length()-1); indexnum=atoi(idstring.c_str()); if (indexnum>0 || idstring=="0") { for (index=compressorvector_instantiated.begin();index!=compressorvector_instantiated.end();++index) { if ((*index)->GetGuid()==indexnum) return (*index); } } return NULL; }

OctaneCompressor * CompressorManager::FindInstantiatedCompressorpFromGuid (  unsigned short int  guidindex  )

Find the pointer to the instantiated compressor referred to by a guid. Returns: NULL if not found Definition at line 239 of file compressormanager.cpp. References compressorvector_instantiated. Referenced by OctaneTester::RunCommand_Decompress(). { // Find the pointer to the instantiated compressor referred to by a guid // return NULL if not found vector<OctaneCompressor*>::iterator index; for (index=compressorvector_instantiated.begin();index!=compressorvector_instantiated.end();++index) { if ((*index)->GetGuid()==guidindex) return (*index); } return NULL; }

OctaneCompressor * CompressorManager::CreateCompressorFromSavedStream (  bitreader &  from  )

Create a new compressor based on file info and load state. Returns: NULL on failure Definition at line 115 of file compressormanager.cpp. References FindBaseCompressorClass(), bitreader::get(), OctaneCompressor::LoadState(), OctaneCompressor::MakeCompressorInstantiation(), and OctaneCompressor::SetInfo(). Referenced by OctaneTester::RunCommand_Decompress(), and OctaneTester::RunCommand_LoadCompressor(). { // in the saved stream we expect to find a 'header' which tells us the 1)compressorclass, 2)compressorname, and 3)compressorguid // then we create a compressor of that type, and tell it to read its state info from the remainder of stream // read standard compressor header (see OctaneCompressor::Save() for where this is written) string compressorclassname; string compressorname; short int compressorguid; from.get(compressorclassname); from.get(compressorname); from.get(compressorguid); // select base compressor class type OctaneCompressor *compressorp = FindBaseCompressorClass(compressorclassname); if (compressorp==NULL) { // couldn't find base class cout << "ERROR: compressor in file is based on compressor class '"<<compressorclassname<<"' which is not known."<<endl; return NULL; } // ask base class to make us a derived class compressorp=compressorp->MakeCompressorInstantiation(); if (compressorp==NULL) { // couldn't find base class cout << "ERROR: failed to instantiate a derived compressor from base class '"<<compressorclassname<<"'."<<endl; return NULL; } // now set details (compressor name and guid) from file compressorp->SetInfo(compressorname,compressorguid); // now load the details from the file bool bretv=compressorp->LoadState(from); if (!bretv) { delete compressorp; compressorp=NULL; } // return pointer to newly created compressor return compressorp; }

bool CompressorManager::AddCompressor (  OctaneCompressor *  compressorp  )

Add an instantiated compressor to our instantiated list. Returns: true on success Definition at line 163 of file compressormanager.cpp. References compressorvector_instantiated. Referenced by OctaneTester::RunCommand_CreateCompressor(), and OctaneTester::RunCommand_LoadCompressor(). { // just add a compressor to the instantiated vector // show some debug info? // cout << "$DEBUG Adding instantiated compressor '" << compressorp->get_compressor_name() << "'."<<endl; compressorvector_instantiated.push_back(compressorp); return true; }

bool CompressorManager::DeleteCompressor (  OctaneCompressor *  compressorp  )

Delete an instantiated compressor to our instantiated list. Returns: true on success Definition at line 174 of file compressormanager.cpp. References compressorvector_instantiated. Referenced by OctaneTester::RunCommand_DeleteCompressor(). { // just add a compressor to the instantiated vector vector<OctaneCompressor*>::iterator index; for (index=compressorvector_instantiated.begin();index!=compressorvector_instantiated.end();++index) { if (*index==compressorp) { // found it, so remove it compressorvector_instantiated.erase(index); return true; } } return false; }

---

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

• core/compressormanager.hpp
• core/compressormanager.cpp

 

Generated on 20 May 2004 by doxygen 1.3.3