spatmod/imagespans.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGESPANS_H
#define  INC_SPATMOD_IMAGESPANS_H

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

namespace SPATMOD {
namespace IMAGE {

//=====================================================================================================================

class SPANS {
   public:

      SPANS ();

      ERRVALUE AdjustForRange (
         double Start,                       
         double Size                         
         );

      void ApplyScale (
         double zoom                         
         );

      double ComputeEnd (
         INT32 span
         ) const;

      INT32 ComputeSpanPos (
         double value,                       
         bool& IsOnBoundary                  
         ) const;

      double ComputeSize (
         INT32 span
         ) const;

      double ComputeStart (
         INT32 span
         ) const;

      MISTRING GetLogString () const;

      UINT32 GetNumSpans (
         ) const { return (m_NumSpans); }

      double GetSpanSizeFirst (
         ) const { return (m_SpanSizeFirst); }

      double GetSpanSizeInterior (
         ) const { return (m_SpanSizeInterior); }

      double GetSpanSizeLast (
         ) const { return (m_SpanSizeLast); }

      double GetSpanSizeMaximum (
         ) const;

      double GetSpanSizeMinimum (
         ) const;

      double GetTotalSize (
         ) const { return (m_TotalSize); }

      bool IsAligned (
         const SPANS& testspans,
         double testoffset
         ) const;

      bool IsEqual (
         const SPANS& rhs
         ) const;

      ERRVALUE SetSpanSizes (
         double SpanSize,
         double SpanSizeFirst = 0,
         double SpanSizeLast = 0
         );

      ERRVALUE SetTotalSize (
         double TotalSize
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      double m_TotalSize;
      double m_SpanSizeFirst;
      double m_SpanSizeInterior;
      double m_SpanSizeLast;
      UINT32 m_NumSpans;

      #endif   // GENERATING_DOXYGEN_OUTPUT

   };

inline bool operator== (
   const SPANS& lhs,
   const SPANS& rhs
   ) { return (lhs.IsEqual(rhs)); }

inline bool operator!= (
   const SPANS& lhs,
   const SPANS& rhs
   ) { return (!lhs.IsEqual(rhs)); }

//=====================================================================================================================

}  // End namespace IMAGE
}  // End namespace SPATMOD

#endif    // INC_SPATMOD_IMAGESPANS_H

---