FEDEM Solver  R8.0
Source code of the dynamics solver
FFaGenericFactory.H
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: 2023 SAP SE
2 //
3 // SPDX-License-Identifier: Apache-2.0
4 //
5 // This file is part of FEDEM - https://openfedem.org
7 
13 #ifndef FFA_GENERIC_FACTORY_H
14 #define FFA_GENERIC_FACTORY_H
15 
16 #include <string>
17 #include <vector>
18 #include <map>
19 #ifdef FFA_DEBUG
20 #include <iostream>
21 #endif
22 
25 
26 
35 template <class T, class Key = std::string, class ArgType = int>
36 class FFaGenericFactory : public FFaSingelton< FFaGenericFactory<T,Key,ArgType> >
37 {
39  using CreatorCB = FFaDynCB2<ArgType,T*&>;
41  using CreatorMap = std::map<Key,CreatorCB>;
42 
43 public:
45  bool registerCreator(const Key& key, const CreatorCB& creator)
46  {
47  return myCreatorMap.emplace(key,creator).second;
48  }
49 
51  T* create(const Key& key, ArgType id)
52  {
53  T* retVal = NULL;
54  typename CreatorMap::iterator creator = myCreatorMap.find(key);
55  if (creator != myCreatorMap.end())
56  creator->second.invoke(id,retVal);
57 #ifdef FFA_DEBUG
58  else
59  std::cerr <<"\n *** FFaGenericFactory: No creator defined for "
60  << key << std::endl;
61 #endif
62  return retVal;
63  }
64 
66  void getKeys(std::vector<Key>& keys) const
67  {
68  keys.clear();
69  keys.reserve(myCreatorMap.size());
70  for (const typename CreatorMap::value_type& creator : myCreatorMap)
71  keys.push_back(creator.first);
72  }
73 
75  void clear() { myCreatorMap.clear(); this->removeInstance(); }
76 
77 private:
79 };
80 
81 #endif
Macros for definition of dynamic callback objects.
Template for singleton classes.
Template singelton class defining a general object creation factory.
Definition: FFaGenericFactory.H:37
bool registerCreator(const Key &key, const CreatorCB &creator)
Registers a new object creation method on key.
Definition: FFaGenericFactory.H:45
void getKeys(std::vector< Key > &keys) const
Gets a list of all registered object creator keys.
Definition: FFaGenericFactory.H:66
FFaDynCB2< ArgType, T *& > CreatorCB
Type alias for object creation callback.
Definition: FFaGenericFactory.H:39
T * create(const Key &key, ArgType id)
Invokes the object creation method for given key.
Definition: FFaGenericFactory.H:51
std::map< Key, CreatorCB > CreatorMap
Key --> creator callback mapping.
Definition: FFaGenericFactory.H:41
void clear()
Clears the object creator map myCreatorMap.
Definition: FFaGenericFactory.H:75
CreatorMap myCreatorMap
Object creator callbacks container.
Definition: FFaGenericFactory.H:78
Template for singleton classes.
Definition: FFaSingelton.H:26
static void removeInstance()
Deletes the dynamically allocated instance.
Definition: FFaSingelton.H:47