MIRA
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ConfigurationPreparePlugin Class Referenceabstract

Base class for prepare plugins. More...

#include <loader/Loader.h>

Inheritance diagram for ConfigurationPreparePlugin:
Inheritance graph
[legend]

Public Member Functions

virtual ~ConfigurationPreparePlugin ()
 
virtual void prepareDocument (XMLDom &xml)=0
 Called by the loader of the configuration file. More...
 
virtual int getOrder () const =0
 Derived classes must return an order for their prepare plugin. More...
 
Class const & getClass () const
 call the virtual internalGetClass(). More...
 

Static Public Member Functions

static PseudoClass const & CLASS ()
 

Protected Member Functions

virtual Class const & internalGetClass () const =0
 

Detailed Description

Base class for prepare plugins.

Prepare plugins are used to modify a configuration file before it gets interpreted by loader plugins.

Constructor & Destructor Documentation

◆ ~ConfigurationPreparePlugin()

virtual ~ConfigurationPreparePlugin ( )
inlinevirtual

Member Function Documentation

◆ prepareDocument()

virtual void prepareDocument ( XMLDom xml)
pure virtual

Called by the loader of the configuration file.

Parameters
[in,out]xmlThe configuration document that can be modified

◆ getOrder()

virtual int getOrder ( ) const
pure virtual

Derived classes must return an order for their prepare plugin.

This value is required, since the order of the prepare plugins is important. Some prepare plugins must be evaluated before others to produce the correct results. The plugins which return the smallest order value are evaluated first.

◆ getClass()

Class const& getClass ( ) const
inlineinherited

call the virtual internalGetClass().

◆ CLASS()

static PseudoClass const& CLASS ( )
inlinestaticinherited

◆ internalGetClass()

virtual Class const& internalGetClass ( ) const
protectedpure virtualinherited

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