rvc/opprofiling.h

Go to the documentation of this file.

#ifndef  INC_RVC_OPPROFILING_H
#define  INC_RVC_OPPROFILING_H

#ifndef  INC_POLYLINE_H
#include <mi32/polyline.h>
#endif

#ifndef  INC_ELEMSTYL_H
#include <mi32/elemstyl.h>
#endif

namespace RVC {

#ifndef GENERATING_DOXYGEN_OUTPUT
class OBJITEM;
#endif // GENERATING_DOXYGEN_OUTPUT

namespace OP {

class PROFILING {
public:

   enum METHOD {
      METHOD_Invalid = -1,
      METHOD_First = 0,
      METHOD_StackProfiles = 0,     
      METHOD_Last = 0,
      METHOD_Count = 1
      };

   class DESTINATION_PARAMETERS {
   public:
      POLYSTYLE m_PolygonStyle;
      LINESTYLE m_LineStyle;
      };

   class METHOD_PARAMETERS {
   public:

      METHOD_PARAMETERS (
         const METHOD method
         ) : m_Method(Check(method)) {}
      virtual ~METHOD_PARAMETERS (
         ) {}

      METHOD GetMethod (
         ) const { return m_Method; };

   private:

#ifndef GENERATING_DOXYGEN_OUTPUT

      const METHOD m_Method;

      METHOD_PARAMETERS (); // not implemented

      static METHOD Check (
         const METHOD method
         ) {
         if (method < METHOD_First) return METHOD_Invalid;
         if (method > METHOD_Last) return METHOD_Invalid;
         return method;
         }

#endif // GENERATING_DOXYGEN_OUTPUT

      };

   class STACKPROFILES_PARAMETERS : public METHOD_PARAMETERS {
   public:

      STACKPROFILES_PARAMETERS (
         ) :
         METHOD_PARAMETERS(METHOD_StackProfiles),
         m_DistanceAcross(12),
         m_DistanceAlong(4),
         m_MaximumAmplitude(32),
         m_RotationAngle(0.0),
         m_SplineType(POLYLINE::SPLINE_NoSpline),
         m_ShowBaselines(false),
         m_ShowAreaAbove(false)
         {}

         ~STACKPROFILES_PARAMETERS () {}

      INT32 GetDistanceAcross (
         ) const { return m_DistanceAcross; }

      INT32 GetDistanceAlong (
         ) const { return m_DistanceAlong; }

      INT32 GetMaximumAmplitude (
         ) const { return m_MaximumAmplitude; }

      double GetRotationAngle (
         ) const { return m_RotationAngle; }

      bool GetShowAreaAbove (
         ) const { return m_ShowAreaAbove; }

      bool GetShowBaselines (
         ) const {return m_ShowBaselines; }

      POLYLINE::SPLINE GetSplineType (
         ) const {return m_SplineType; }

      INT32 SetDistanceAcross (
         const INT32 distance
         ) { m_DistanceAcross = bound(distance, 1, 8192); return m_DistanceAcross; }

      INT32 SetDistanceAlong (
         const INT32 distance
         ) { m_DistanceAlong = bound(distance, 1, 8192); return m_DistanceAlong; }

      INT32 SetMaximumAmplitude (
         const INT32 amplitude
         ) { m_MaximumAmplitude = bound(amplitude, 1, 8192); return m_MaximumAmplitude; }

      double SetRotationAngle (
         const double angle
         ) { m_RotationAngle = bound(angle, -90.0, 90.0); return m_RotationAngle; }

      void SetShowAreaAbove (
         const bool show
         ) { m_ShowAreaAbove = show; }

      void SetShowBaselines (
         const bool show
         ) { m_ShowBaselines = show; }

      void SetSplineType (
         const POLYLINE::SPLINE spline
         ) { m_SplineType = spline; }

   private:

#ifndef GENERATING_DOXYGEN_OUTPUT

      INT32 m_DistanceAcross;
      INT32 m_DistanceAlong;
      INT32 m_MaximumAmplitude;
      double m_RotationAngle;

      POLYLINE::SPLINE m_SplineType;

      bool m_ShowBaselines;
      bool m_ShowAreaAbove;

#endif // GENERATING_DOXYGEN_OUTPUT

      };

      static ERRVALUE Process (
         const RVC::OBJITEM& SrcObjItem,
         RVC::OBJITEM& DestObjItem, 
         const METHOD_PARAMETERS* MethodParameters,
         const DESTINATION_PARAMETERS& DestParameters 
         );

      static ERRVALUE ProcessStackProfiles (
         const RVC::OBJITEM& SrcObjItem,
         RVC::OBJITEM& DestObjItem, 
         const STACKPROFILES_PARAMETERS& MethodParameters,
         const DESTINATION_PARAMETERS& DestParameters 
         );
        
};

}  // end namespace OP
}  // end namespace RVC


#endif  // INC_RVC_OPPROFILING_H

---