marlinmt::EmptyGeometry Class Reference
EmptyGeometry class Implement an empty geometry. More...
Inherits marlinmt::GeometryPlugin.
Public Member Functions | |
| EmptyGeometry (const EmptyGeometry &)=delete | |
| EmptyGeometry & | operator= (const EmptyGeometry &)=delete |
| EmptyGeometry () | |
 Public Member Functions inherited from marlinmt::GeometryPlugin | |
| GeometryPlugin ()=delete | |
| virtual | ~GeometryPlugin ()=default |
| GeometryPlugin (const GeometryPlugin &)=delete | |
| GeometryPlugin & | operator= (const GeometryPlugin &)=delete |
| void | print () const |
| Print the complete geometry plugin description. More... | |
| Public Member Functions inherited from marlinmt::Component | |
| Component ()=delete | |
| No default constructor. More... | |
| Component (const Component &)=delete | |
| No copy or assignement. More... | |
| Component & | operator= (const Component &)=delete |
| virtual | ~Component ()=default |
| Default destructor. More... | |
| Component (const std::string &type) | |
| Constructor with component type. More... | |
| const std::string & | type () const |
| Get the component name. More... | |
| const std::string & | name () const |
| Get the component name. More... | |
| void | setName (const std::string &n) |
| Set the component name. More... | |
| const std::string & | description () const |
| Get the component description. More... | |
| void | setDescription (const std::string &desc) |
| Set the component description. More... | |
| const Application & | application () const |
| Get the application in which the component is registered. More... | |
| Application & | application () |
| Get the application in which the component is registered. More... | |
| template<class T > | |
| Logging::StreamType | log () const |
| Log a message with specific log level. More... | |
| Logging::StreamType | debug () const |
| Shortcut for log<DEBUG>() More... | |
| Logging::StreamType | message () const |
| Shortcut for log<MESSAGE>() More... | |
| Logging::StreamType | warning () const |
| Shortcut for log<WARNING>() More... | |
| Logging::StreamType | error () const |
| Shortcut for log<ERROR>() More... | |
| void | setVerbosity (const std::string &level) |
| Set the verbosity level. More... | |
| const std::string & | verbosity () const |
| Get the verbosity level. More... | |
| bool | isInitialized () const |
| Whether the component has been initialized. More... | |
| void | setup (Application *app) |
| Setup the component. More... | |
| void | printParameters () const |
| Print the component parameters. More... | |
| template<class T > | |
| void | printParameters () const |
| Print the component parameters at specific verbosity. More... | |
| void | setParameters (const ConfigSection §ion, bool throwIfNotFound=false) |
| Set the parameters from the configuration section. More... | |
| void | getParameters (ConfigSection §ion, const std::set< std::string > &exclude={}) const |
| Get the parameters from configurable object and populate the config section with. More... | |
| Public Member Functions inherited from marlinmt::Configurable | |
| Configurable ()=default | |
| virtual | ~Configurable ()=default |
| template<typename T > | |
| std::shared_ptr< ParameterImpl > | addParameter (EParameterType paramType, const std::string &name, const std::string &desc, std::shared_ptr< T > value) |
| Add a parameter. More... | |
| template<typename T > | |
| std::shared_ptr< ParameterImpl > | addParameter (EParameterType paramType, const std::string &name, const std::string &desc, std::shared_ptr< T > value, T defVal) |
| Add a parameter. More... | |
| template<typename T > | |
| T | parameter (const std::string &name) const |
| Get a parameter value. More... | |
| template<typename T > | |
| T | parameter (const std::string &name, const T &fallback) const |
| Get a parameter value. More... | |
| void | checkParameter (const std::string &name) const |
| Check if the parameter has been registered. More... | |
| bool | exists (const std::string &name) const |
| Return true if the parameter has been registered. More... | |
| bool | isSet (const std::string &name) const |
| Returns true if the parameter exists and is set, false otherwise. More... | |
| void | clear () |
| Remove all parameters. More... | |
| void | unset () |
| Unset all registered parameters. More... | |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
Protected Member Functions | |
| void | loadGeometry () override |
| Load the geometry. More... | |
| const void * | handle () const override |
| Get a handle on the geometry instance. More... | |
| void | destroy () override |
| Cleanup geometry. More... | |
| std::type_index | typeIndex () const override |
| Get a type index object from the geometry handle. More... | |
| void | dumpGeometry () const override |
| Dump the geometry in the console. More... | |
| Protected Member Functions inherited from marlinmt::GeometryPlugin | |
| GeometryPlugin (const std::string >ype) | |
| Constructor. More... | |
| virtual void | initialize () override |
| Init the geometry plugin. More... | |
Additional Inherited Members | |
| Public Types inherited from marlinmt::Component | |
| using | LoggerPtr = Logging::Logger |
| Public Types inherited from marlinmt::Configurable | |
| using | ParameterMap = std::map< std::string, std::shared_ptr< ParameterImpl > > |
| using | iterator = ParameterMap::iterator |
| using | const_iterator = ParameterMap::const_iterator |
| Protected Attributes inherited from marlinmt::GeometryPlugin | |
| BoolParameter | _dumpGeometry {*this, "DumpGeometry", "Whether to dump the geometry on creation", false} |
| Whether to dump the geometry on creation. More... | |
| Protected Attributes inherited from marlinmt::Component | |
| std::string | _type {} |
| The component type. More... | |
| std::string | _name {} |
| The component name. More... | |
| std::string | _description {"No description"} |
| The component description. More... | |
| Application * | _application {nullptr} |
| The application in which the component has been registered. More... | |
| LoggerPtr | _logger {nullptr} |
| The logger instance. More... | |
| StringParameter | _verbosity { *this, "Verbosity", "The component verbosity level", "MESSAGE" } |
| The verbosity level of the logger (parameter) More... | |
| Protected Attributes inherited from marlinmt::Configurable | |
| ParameterMap | _parameters {} |
| The parameter map. More... | |
Detailed Description
EmptyGeometry class Implement an empty geometry.
Definition at line 12 of file EmptyGeometry.cc.
Constructor & Destructor Documentation
◆ EmptyGeometry() [1/2]
|
delete |
◆ EmptyGeometry() [2/2]
|
inline |
Definition at line 18 of file EmptyGeometry.cc.
Member Function Documentation
◆ destroy()
|
inlineoverrideprotectedvirtual |
Cleanup geometry.
Implements marlinmt::GeometryPlugin.
Definition at line 23 of file EmptyGeometry.cc.
◆ dumpGeometry()
|
inlineoverrideprotectedvirtual |
Dump the geometry in the console.
Implements marlinmt::GeometryPlugin.
Definition at line 25 of file EmptyGeometry.cc.
References MARLINMT_DECLARE_GEOMETRY.
◆ handle()
|
inlineoverrideprotectedvirtual |
Get a handle on the geometry instance.
Implements marlinmt::GeometryPlugin.
Definition at line 22 of file EmptyGeometry.cc.
◆ loadGeometry()
|
inlineoverrideprotectedvirtual |
Load the geometry.
Implements marlinmt::GeometryPlugin.
Definition at line 21 of file EmptyGeometry.cc.
◆ operator=()
|
delete |
◆ typeIndex()
|
inlineoverrideprotectedvirtual |
Get a type index object from the geometry handle.
Implements marlinmt::GeometryPlugin.
Definition at line 24 of file EmptyGeometry.cc.
The documentation for this class was generated from the following file:
