SampleBuilderFactory Class Reference

Inheritance diagram for SampleBuilderFactory:

Collaboration diagram for SampleBuilderFactory:

Public Types
typedef std::function< ISampleBuilder *()>	CreateItemCallback
typedef std::map< std::string, CreateItemCallback >	CallbackMap_t

Public Member Functions
	SampleBuilderFactory ()
MultiLayer *	createSampleByName (const std::string &name)
ISampleBuilder *	createItem (const std::string &item_key) const
std::unique_ptr< ISampleBuilder >	createItemPtr (const std::string &item_key) const
bool	registerItem (const std::string &item_key, CreateItemCallback CreateFn)
bool	contains (const std::string &item_key) const
size_t	size () const

Protected Attributes
CallbackMap_t	m_callbacks

Detailed Description

Factory to create standard pre-defined samples.

Definition at line 26 of file SampleBuilderFactory.h.

Member Typedef Documentation

CreateItemCallback

typedef std::function<ISampleBuilder *()> IFactory< std::string , ISampleBuilder >::CreateItemCallback

inherited

function which will be used to create object of AbstractProduct base type

Definition at line 32 of file IFactory.h.

CallbackMap_t

typedef std::map<std::string , CreateItemCallback> IFactory< std::string , ISampleBuilder >::CallbackMap_t

inherited

map for correspondance between object identifier and object creation function

Definition at line 35 of file IFactory.h.

Constructor & Destructor Documentation

SampleBuilderFactory()

SampleBuilderFactory::SampleBuilderFactory

(

)

Definition at line 49 of file SampleBuilderFactory.cpp.

{
    registerItem("CylindersAndPrismsBuilder", create_new<CylindersAndPrismsBuilder>);
 
    registerItem("TwoTypesCylindersDistributionBuilder",
                 create_new<TwoTypesCylindersDistributionBuilder>);
 
    registerItem("CylindersInBABuilder", create_new<CylindersInBABuilder>);
    registerItem("CylindersInDWBABuilder", create_new<CylindersInDWBABuilder>);
    registerItem("LargeCylindersInDWBABuilder", create_new<LargeCylindersInDWBABuilder>);
 
    registerItem("CylindersWithSizeDistributionBuilder",
                 create_new<CylindersWithSizeDistributionBuilder>);
 
    registerItem("RadialParaCrystalBuilder", create_new<RadialParaCrystalBuilder>);
 
    registerItem("HardDiskBuilder", create_new<HardDiskBuilder>);
 
    registerItem("Basic2DParaCrystalBuilder", create_new<Basic2DParaCrystalBuilder>);
 
    registerItem("HexParaCrystalBuilder", create_new<HexParaCrystalBuilder>);
 
    registerItem("Lattice1DBuilder", create_new<Lattice1DBuilder>);
 
    registerItem("RectParaCrystalBuilder", create_new<RectParaCrystalBuilder>);
 
    registerItem("Basic2DLatticeBuilder", create_new<Basic2DLatticeBuilder>);
 
    registerItem("SquareLatticeBuilder", create_new<SquareLatticeBuilder>);
 
    registerItem("CenteredSquareLatticeBuilder", create_new<CenteredSquareLatticeBuilder>);
 
    registerItem("RotatedSquareLatticeBuilder", create_new<RotatedSquareLatticeBuilder>);
 
    registerItem("FiniteSquareLatticeBuilder", create_new<FiniteSquareLatticeBuilder>);
 
    registerItem("SuperLatticeBuilder", create_new<SuperLatticeBuilder>);
 
    registerItem("CustomMorphologyBuilder", create_new<CustomMorphologyBuilder>);
 
    registerItem("RotatedPyramidsBuilder", create_new<RotatedPyramidsBuilder>);
 
    registerItem("CoreShellParticleBuilder", create_new<CoreShellParticleBuilder>);
 
    registerItem("CoreShellBoxRotateZandYBuilder", create_new<CoreShellBoxRotateZandYBuilder>);
 
    registerItem("SizeDistributionDAModelBuilder", create_new<SizeDistributionDAModelBuilder>);
 
    registerItem("SizeDistributionLMAModelBuilder", create_new<SizeDistributionLMAModelBuilder>);
 
    registerItem("SizeDistributionSSCAModelBuilder", create_new<SizeDistributionSSCAModelBuilder>);
 
    registerItem("CylindersInSSCABuilder", create_new<CylindersInSSCABuilder>);
 
    registerItem("MesoCrystalBuilder", create_new<MesoCrystalBuilder>);
 
    registerItem("MagneticParticleZeroFieldBuilder", create_new<MagneticParticleZeroFieldBuilder>);
 
    registerItem("MagneticCylindersBuilder", create_new<MagneticCylindersBuilder>);
 
    registerItem("MagneticSubstrateZeroFieldBuilder",
                 create_new<MagneticSubstrateZeroFieldBuilder>);
 
    registerItem("SimpleMagneticLayerBuilder", create_new<SimpleMagneticLayerBuilder>);
 
    registerItem("SimpleMagneticRotationBuilder", create_new<SimpleMagneticRotationBuilder>);
 
    registerItem("MagneticLayerBuilder", create_new<MagneticLayerBuilder>);
 
    registerItem("FeNiBilayerBuilder", create_new<FeNiBilayerBuilder>);
 
    registerItem("FeNiBilayerTanhBuilder", create_new<FeNiBilayerTanhBuilder>);
 
    registerItem("FeNiBilayerNCBuilder", create_new<FeNiBilayerNCBuilder>);
 
    registerItem("FeNiBilayerSpinFlipBuilder", create_new<FeNiBilayerSpinFlipBuilder>);
 
    registerItem("FeNiBilayerSpinFlipTanhBuilder", create_new<FeNiBilayerSpinFlipTanhBuilder>);
 
    registerItem("FeNiBilayerSpinFlipNCBuilder", create_new<FeNiBilayerSpinFlipNCBuilder>);
 
    registerItem("MagneticRotationBuilder", create_new<MagneticRotationBuilder>);
 
    registerItem("MagneticSpheresBuilder", create_new<MagneticSpheresBuilder>);
 
    registerItem("MultiLayerWithRoughnessBuilder", create_new<MultiLayerWithRoughnessBuilder>);
 
    registerItem("MultiLayerWithNCRoughnessBuilder", create_new<MultiLayerWithNCRoughnessBuilder>);
 
    registerItem("TwoLayerRoughnessBuilder", create_new<TwoLayerRoughnessBuilder>);
 
    registerItem("MultipleLayoutBuilder", create_new<MultipleLayoutBuilder>);
 
    registerItem("TriangularRippleBuilder", create_new<TriangularRippleBuilder>);
 
    registerItem("AsymRippleBuilder", create_new<AsymRippleBuilder>);
 
    registerItem("CosineRippleBuilder", create_new<CosineRippleBuilder>);
 
    registerItem("ParticleCompositionBuilder", create_new<ParticleCompositionBuilder>);
 
    registerItem("BoxCompositionRotateXBuilder", create_new<BoxCompositionRotateXBuilder>);
 
    registerItem("BoxCompositionRotateYBuilder", create_new<BoxCompositionRotateYBuilder>);
 
    registerItem("BoxCompositionRotateZBuilder", create_new<BoxCompositionRotateZBuilder>);
 
    registerItem("BoxCompositionRotateZandYBuilder", create_new<BoxCompositionRotateZandYBuilder>);
 
    registerItem("BoxStackCompositionBuilder", create_new<BoxStackCompositionBuilder>);
 
    registerItem("ParticleInVacuumBuilder", create_new<ParticleInVacuumBuilder>);
 
    registerItem("TransformBoxBuilder", create_new<TransformBoxBuilder>);
 
    registerItem("LayersWithAbsorptionBuilder", create_new<LayersWithAbsorptionBuilder>);
 
    registerItem("LayersWithAbsorptionBySLDBuilder", create_new<LayersWithAbsorptionBySLDBuilder>);
 
    registerItem("BoxesSquareLatticeBuilder", create_new<BoxesSquareLatticeBuilder>);
 
    registerItem("RotatedCylindersBuilder", create_new<RotatedCylindersBuilder>);
 
    registerItem("SlicedCompositionBuilder", create_new<SlicedCompositionBuilder>);
 
    registerItem("RotatedPyramidsDistributionBuilder",
                 create_new<RotatedPyramidsDistributionBuilder>);
 
    registerItem("SpheresWithLimitsDistributionBuilder",
                 create_new<SpheresWithLimitsDistributionBuilder>);
 
    registerItem("ConesWithLimitsDistributionBuilder",
                 create_new<ConesWithLimitsDistributionBuilder>);
 
    registerItem("LinkedBoxDistributionBuilder", create_new<LinkedBoxDistributionBuilder>);
 
    registerItem("HomogeneousMultilayerBuilder", create_new<HomogeneousMultilayerBuilder>);
 
    registerItem("PlainMultiLayerBySLDBuilder", create_new<PlainMultiLayerBySLDBuilder>);
 
    registerItem("ResonatorBuilder", create_new<ResonatorBuilder>);
 
    registerItem("SlicedCylindersBuilder", create_new<SlicedCylindersBuilder>);
 
    registerItem("SLDSlicedCylindersBuilder", create_new<SLDSlicedCylindersBuilder>);
 
    registerItem("AveragedSlicedCylindersBuilder", create_new<AveragedSlicedCylindersBuilder>);
 
    registerItem("ThickAbsorptiveSampleBuilder", create_new<ThickAbsorptiveSampleBuilder>);
}

References IFactory< std::string, ISampleBuilder >::registerItem().

Here is the call graph for this function:

Member Function Documentation

createSampleByName()

MultiLayer * SampleBuilderFactory::createSampleByName

(

const std::string &

name

)

Retrieves a SampleBuilder from the registry, does the build, and returns the result.

Definition at line 202 of file SampleBuilderFactory.cpp.

{
    return createItemPtr(name)->buildSample();
}

References IFactory< std::string, ISampleBuilder >::createItemPtr().

Here is the call graph for this function:

createItem()

ISampleBuilder * IFactory< std::string , ISampleBuilder >::createItem ( const std::string &  item_key ) const

inlineinherited

Creates object by calling creation function corresponded to given identifier.

Definition at line 38 of file IFactory.h.

    {
        auto it = m_callbacks.find(item_key);
        assert(it != m_callbacks.end());
        return (it->second)();
    }

createItemPtr()

std::unique_ptr<ISampleBuilder > IFactory< std::string , ISampleBuilder >::createItemPtr ( const std::string &  item_key ) const

inlineinherited

Definition at line 46 of file IFactory.h.

    {
        return std::unique_ptr<AbstractProduct>{createItem(item_key)};
    }

registerItem()

bool IFactory< std::string , ISampleBuilder >::registerItem ( const std::string &  item_key, CreateItemCallback  CreateFn  )

inlineinherited

Registers object's creation function.

Definition at line 53 of file IFactory.h.

    {
        assert(m_callbacks.find(item_key) == m_callbacks.end());
        return m_callbacks.insert(make_pair(item_key, CreateFn)).second;
    }

contains()

bool IFactory< std::string , ISampleBuilder >::contains ( const std::string &  item_key ) const

inlineinherited

Definition at line 59 of file IFactory.h.

    {
        return m_callbacks.find(item_key) != m_callbacks.end();
    }

size()

size_t IFactory< std::string , ISampleBuilder >::size ( ) const

inlineinherited

Returns number of registered objects.

Definition at line 65 of file IFactory.h.

{ return m_callbacks.size(); }

Member Data Documentation

m_callbacks

CallbackMap_t IFactory< std::string , ISampleBuilder >::m_callbacks

protectedinherited

map of correspondence of objectsId and creation functions

Definition at line 68 of file IFactory.h.

---

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

• /home/www/ba/Sample/StandardSamples/SampleBuilderFactory.h
• /home/www/ba/Sample/StandardSamples/SampleBuilderFactory.cpp