include/Plugins/PseudoLayerPlugin.h

0001 /**
0002  *  @file   PandoraSDK/include/Utilities/PseudoLayerPlugin.h
0003  *
0004  *  @brief  Header file for the pseudo layer plugin interface class.
0005  *
0006  *  $Log: $
0007  */
0008 #ifndef PANDORA_PSEUDO_LAYER_PLUGIN_H
0009 #define PANDORA_PSEUDO_LAYER_PLUGIN_H 1
0010
0011 #include "Pandora/PandoraInternal.h"
0012 #include "Pandora/Process.h"
0013
0014 namespace pandora
0015 {
0016
0017 /**
0018  *  @brief  PseudoLayerPlugin class
0019  */
0020 class PseudoLayerPlugin : public Process
0021 {
0022 public:
0023     /**
0024      *  @brief  Get the appropriate pseudolayer for a specified position vector
0025      *
0026      *  @param  positionVector the specified position
0027      *
0028      *  @return the appropriate pseudolayer
0029      */
0030     virtual unsigned int GetPseudoLayer(const CartesianVector &positionVector) const = 0;
0031
0032     /**
0033      *  @brief  Get the pseudolayer assigned to a point at the ip, i.e. the initial offset for pseudolayer values
0034      *          and the start of the pseudolayer scale
0035      *
0036      *  @return the pseudolayer assigned to a point at the ip
0037      */
0038     virtual unsigned int GetPseudoLayerAtIp() const = 0;
0039
0040 protected:
0041     friend class PluginManager;
0042 };
0043
0044 } // namespace pandora
0045
0046 #endif // #ifndef PANDORA_PSEUDO_LAYER_PLUGIN_H