API documentation
CoilPrototypeFactory Class Reference
This interface knows about coil prototypes. More...
#include <CoilPrototypeFactory.h>
Inheritance diagram for CoilPrototypeFactory:
Collaboration diagram for CoilPrototypeFactory:
Public Member Functions | |
| CoilPrototypeFactory () | |
| Constructor. | |
| virtual | ~CoilPrototypeFactory () |
| Destructor. | |
| Coil * | Clone (DOMNode *node) |
| Clone a coil by node type. | |
| Coil * | Clone (string name) |
| Clone a coil by name. | |
| map< string, Coil * > * | getList () |
| Get list of all coil prototypes. | |
Protected Member Functions | |
| Coil * | get (string name) |
| int | upper (int c) |
Detailed Description
This interface knows about coil prototypes.
Definition at line 33 of file CoilPrototypeFactory.h.
Constructor & Destructor Documentation
| CoilPrototypeFactory::CoilPrototypeFactory | ( | ) |
Constructor.
Will initialise with the available Prototypes. Every available coil type needs to be registered here. Also include the header of the module in the coilprototypefactory.cpp
Definition at line 34 of file CoilPrototypeFactory.cpp.
Member Function Documentation
| Coil * CoilPrototypeFactory::Clone | ( | DOMNode * | node | ) |
Clone a coil by node type.
- Parameters:
-
node DOMNode containing coil attributes.
- Returns:
- The pointer to the cloned Coil
Reimplemented from PrototypeFactory.
Definition at line 49 of file CoilPrototypeFactory.cpp.
References Coil::Clone().
Referenced by CoilArray::CreateCoil().
Here is the call graph for this function:
Here is the caller graph for this function:
| Coil * CoilPrototypeFactory::Clone | ( | string | name | ) |
Clone a coil by name.
- Parameters:
-
name of the coil
- Returns:
- The pointer to the cloned Coil
Reimplemented from PrototypeFactory.
Definition at line 64 of file CoilPrototypeFactory.cpp.
References Coil::Clone().
Here is the call graph for this function:
| Coil * CoilPrototypeFactory::get | ( | string | name | ) | [protected] |
Get Coil
- Parameters:
-
name
Reimplemented from PrototypeFactory.
Definition at line 44 of file CoilPrototypeFactory.cpp.
| map<string, Coil*>* CoilPrototypeFactory::getList | ( | ) | [inline] |
Get list of all coil prototypes.
- Returns:
- Pointer to the coil prototype list.
Reimplemented from PrototypeFactory.
Definition at line 73 of file CoilPrototypeFactory.h.
| int CoilPrototypeFactory::upper | ( | int | c | ) | [protected] |
Upper case
- Parameters:
-
c Char to be converted.
- Returns:
- Converted char.
Reimplemented from PrototypeFactory.
The documentation for this class was generated from the following files:
