Atoms Crowd  4.1.0
Atoms::VariationLoaderFactory Class Reference

VariationLoader factory. More...

#include <VariationLoaderFactory.h>

Public Types

typedef AtomsPtr< BaseVariationLoader >(* creatorFn) ()
 

Public Member Functions

AtomsPtr< BaseVariationLoadercreateVariationLoader (const std::string &typeName)
 Creates an variation loader. More...
 
void registerVariationLoader (const std::string &name, creatorFn funct)
 Registers a new variation loader type in the factory. More...
 
void deregisterVariationLoader (const std::string &name)
 Deregisters an variation loader type from the factory. More...
 
std::vector< std::string > getRegisteredVariationLoader ()
 Gets all registered variation loader. More...
 
bool isRegistered (const std::string &name)
 Checks if an variation loader type with the given name is registered. More...
 

Static Public Member Functions

static VariationLoaderFactoryinstance ()
 Singleton access.
 

Detailed Description

VariationLoader factory.

VariationLoader factory used to create variation loaders.

Member Function Documentation

◆ createVariationLoader()

AtomsPtr<BaseVariationLoader> Atoms::VariationLoaderFactory::createVariationLoader ( const std::string &  typeName)

Creates an variation loader.

Parameters
typeNamevariation loader type
Returns
Pointer to the variation loader

◆ deregisterVariationLoader()

void Atoms::VariationLoaderFactory::deregisterVariationLoader ( const std::string &  name)

Deregisters an variation loader type from the factory.

Parameters
nameBaseVariationLoader type name

◆ getRegisteredVariationLoader()

std::vector<std::string> Atoms::VariationLoaderFactory::getRegisteredVariationLoader ( )

Gets all registered variation loader.

Returns
List of all variation loader type registered

◆ isRegistered()

bool Atoms::VariationLoaderFactory::isRegistered ( const std::string &  name)

Checks if an variation loader type with the given name is registered.

Parameters
nameBaseVariationLoader type name
Returns
Return true if the type is already registered

◆ registerVariationLoader()

void Atoms::VariationLoaderFactory::registerVariationLoader ( const std::string &  name,
creatorFn  funct 
)

Registers a new variation loader type in the factory.

Parameters
nameBaseVariationLoader type name \patam funct creator function

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