CIccStructCreator Class Reference

Class: CIccStructCreator. More...

#include <IccStructFactory.h>

Collaboration diagram for CIccStructCreator:

Public Member Functions
	~CIccStructCreator ()

Static Public Member Functions
static IIccStruct *	CreateStruct (icStructSignature structTypeSig, CIccTagStruct *pTagStruct)
	Function: CreateStruct(structTypeSig) Create a element of type structTypeSig.
static icStructSignature	GetStructSig (const icChar *structName)
	Function: GetStructSig(structName) Get signature of structure from display name.
static bool	GetStructSigName (std::string &structName, icStructSignature structTypeSig, bool bFillUnknown=true)
	Function: GetStructSigName(structTypeSig) Get display name of structTypeSig.
static IIccStructFactory *	PopFactory ()
	Function: PopFactory() Remove the top IIccStructFactory from the stack of element factories tracked by the system.
static void	PushFactory (IIccStructFactory *pFactory)
	Function: PushFactory(pFactory) Add an IIccStructFactory to the stack of element factories tracked by the system.

Private Member Functions
	CIccStructCreator ()
	Only GetInstance() can create the singleton.
IIccStruct *	DoCreateStruct (icStructSignature structTypeSig, CIccTagStruct *pTagStruct=NULL)
icStructSignature	DoGetStructSig (const char *structName)
bool	DoGetStructSigName (std::string &structName, icStructSignature structTypeSig, bool bFillUnknown=true)
IIccStructFactory *	DoPopFactory (bool bAll=false)
void	DoPushFactory (IIccStructFactory *pFactory)

Static Private Member Functions
static CIccStructCreator *	GetInstance ()
	Function: GetInstance() Private static function to access singleton CiccStructCreator Object.

Private Attributes
CIccStructFactoryList	factoryStack

Static Private Attributes
static CIccStructCreatorPtr	theStructCreator

Detailed Description

Class: CIccStructCreator.

Purpose: CIccStructCreator uses a singleton pattern to provide dynamically upgradeable IIccStructObject derived object creation based on element signature.

Definition at line 219 of file IccStructFactory.h.

Constructor & Destructor Documentation

~CIccStructCreator()

CIccStructCreator::~CIccStructCreator

(

)

Definition at line 165 of file IccStructFactory.cpp.

{
  IIccStructFactory *pFactory = DoPopFactory(true);
 
  while (pFactory) {
    delete pFactory;
    pFactory = DoPopFactory(true);
  }
}

CIccStructCreator()

CIccStructCreator::CIccStructCreator ( )

inlineprivate

Only GetInstance() can create the singleton.

Definition at line 306 of file IccStructFactory.h.

{ }

Member Function Documentation

CreateStruct()

static IIccStruct * CIccStructCreator::CreateStruct ( icStructSignature structTypeSig, CIccTagStruct * pTagStruct )

inlinestatic

Function: CreateStruct(structTypeSig) Create a element of type structTypeSig.

Parameter(s): structTypeSig = signature of the ICC element type for the element to be created

Returns a new CIccProcessStruct object of the given signature type. Each factory in the factoryStack is used until a factory supports the signature type.

Definition at line 236 of file IccStructFactory.h.

      { return CIccStructCreator::GetInstance()->DoCreateStruct(structTypeSig, pTagStruct); }

References DoCreateStruct(), and GetInstance().

Referenced by CIccTagStruct::Describe(), CIccTagStruct::GetStructHandler(), and CIccTagStruct::SetTagStructType().

Here is the call graph for this function:

Here is the caller graph for this function:

DoCreateStruct()

IIccStruct * CIccStructCreator::DoCreateStruct ( icStructSignature structTypeSig, CIccTagStruct * pTagStruct = NULL )

private

Definition at line 186 of file IccStructFactory.cpp.

{
  CIccStructFactoryList::iterator i;
  IIccStruct *rv = NULL;
 
  for (i=factoryStack.begin(); i!=factoryStack.end(); i++) {
    rv = (*i)->CreateStruct(structTypeSig, pTagStruct);
    if (rv)
      break;
  }
  return rv;
}

Referenced by CreateStruct().

Here is the caller graph for this function:

DoGetStructSig()

icStructSignature CIccStructCreator::DoGetStructSig ( const char * structName )

private

Definition at line 211 of file IccStructFactory.cpp.

{
  CIccStructFactoryList::iterator i;
 
  for (i = factoryStack.begin(); i != factoryStack.end(); i++) {
    icStructSignature rv = (*i)->GetStructSig(structName);
    if (rv)
      return rv;
  }
 
  return (icStructSignature)0;
}

Referenced by GetStructSig().

Here is the caller graph for this function:

DoGetStructSigName()

bool CIccStructCreator::DoGetStructSigName ( std::string & structName, icStructSignature structTypeSig, bool bFillUnknown = true )

private

Definition at line 199 of file IccStructFactory.cpp.

{
  CIccStructFactoryList::iterator i;
 
  for (i=factoryStack.begin(); i!=factoryStack.end(); i++) {
    if ((*i)->GetStructSigName(structName, structTypeSig, bFillUnknown))
      return true;
  }
 
  return false;
}

Referenced by GetStructSigName().

Here is the caller graph for this function:

DoPopFactory()

IIccStructFactory * CIccStructCreator::DoPopFactory ( bool bAll = false )

private

Definition at line 229 of file IccStructFactory.cpp.

{
  if (factoryStack.size()>0) {
    CIccStructFactoryList::iterator i=factoryStack.begin();
    IIccStructFactory* rv = (*i);
    factoryStack.pop_front();
    return rv;
  }
  return NULL;
}

Referenced by PopFactory().

Here is the caller graph for this function:

DoPushFactory()

void CIccStructCreator::DoPushFactory ( IIccStructFactory * pFactory )

private

Definition at line 224 of file IccStructFactory.cpp.

{
  factoryStack.push_front(pFactory);
}

GetInstance()

CIccStructCreator * CIccStructCreator::GetInstance ( )

staticprivate

Function: GetInstance() Private static function to access singleton CiccStructCreator Object.

Parameter(s): None

Returns the singleton CIccStructCreator object. It will allocate a new one and push a single CIccSpecStruct Factory object onto the factory stack if the singleton has not been intialized.

Definition at line 175 of file IccStructFactory.cpp.

{
  if (!theStructCreator.get()) {
    theStructCreator = CIccStructCreatorPtr(new CIccStructCreator);
 
    theStructCreator->DoPushFactory(new CIccBasicStructFactory);
  }
 
  return theStructCreator.get();
}

Referenced by CreateStruct(), GetStructSig(), GetStructSigName(), PopFactory(), and PushFactory().

Here is the caller graph for this function:

GetStructSig()

static icStructSignature CIccStructCreator::GetStructSig ( const icChar * structName )

inlinestatic

Function: GetStructSig(structName) Get signature of structure from display name.

Parameter(s): structName = struct display name

Returns signature of structure if it is recognized by any factory, 0 if the all the factories don't create a structure with such a display name.

Definition at line 266 of file IccStructFactory.h.

  {
    return CIccStructCreator::GetInstance()->DoGetStructSig(structName);
  }

References DoGetStructSig(), and GetInstance().

Referenced by CIccTagXmlStruct::ParseXml().

Here is the call graph for this function:

Here is the caller graph for this function:

GetStructSigName()

static bool CIccStructCreator::GetStructSigName ( std::string & structName, icStructSignature structTypeSig, bool bFillUnknown = true )

inlinestatic

Function: GetStructSigName(structTypeSig) Get display name of structTypeSig.

Parameter(s): structName = string to put struct name into structTypeSig = signature of the ICC struct type to get a name for bFillUnknown = flag to indicate structName is filled if not found

Returns true if struct type is recognized by any factory, false if all factories do not create structTypeSig structs. If struct type is not recognized by any factories a suitable display name will be placed in structName if bFillUknown is true.

Definition at line 253 of file IccStructFactory.h.

      { return CIccStructCreator::GetInstance()->DoGetStructSigName(structName, structTypeSig, bFillUnknown); }

References DoGetStructSigName(), and GetInstance().

Referenced by CIccTagStruct::Describe(), and CIccInfo::GetStructSigName().

Here is the call graph for this function:

Here is the caller graph for this function:

PopFactory()

static IIccStructFactory * CIccStructCreator::PopFactory ( )

inlinestatic

Function: PopFactory() Remove the top IIccStructFactory from the stack of element factories tracked by the system.

Parameter(s): None

Returns the top IIccStructFactory from the stack of element factories tracked by the system. The returned element factory is no longer owned by the system and needs to be deleted to avoid memory leaks.

Note: The initial CIccBasicElemFactory cannot be popped off the stack.

Definition at line 301 of file IccStructFactory.h.

      { return CIccStructCreator::GetInstance()->DoPopFactory(); }

References DoPopFactory(), and GetInstance().

Here is the call graph for this function:

PushFactory()

static void CIccStructCreator::PushFactory ( IIccStructFactory * pFactory )

inlinestatic

Function: PushFactory(pFactory) Add an IIccStructFactory to the stack of element factories tracked by the system.

Parameter(s): pFactory = pointer to an IIccStructFactory object to add to the system. The pFactory must be created with new, and will be owned CIccStructCreator until popped off the stack using PopFactory(). Any factories not popped off will be taken care of properly on application shutdown.

Definition at line 284 of file IccStructFactory.h.

      { CIccStructCreator::GetInstance()->CIccStructCreator::DoPushFactory(pFactory); }

References GetInstance().

Here is the call graph for this function:

Member Data Documentation

factoryStack

CIccStructFactoryList CIccStructCreator::factoryStack

private

Definition at line 329 of file IccStructFactory.h.

theStructCreator

std::unique_ptr< CIccStructCreator > CIccStructCreator::theStructCreator

staticprivate

Definition at line 327 of file IccStructFactory.h.

---

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

• IccProfLib/IccStructFactory.h
• IccProfLib/IccStructFactory.cpp