SOSM_SpectralObject.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI//REL TO USA ONLY
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef SOSM_SPECTRALOBJECT_HPP
#define SOSM_SPECTRALOBJECT_HPP
 
#include "sosm_export.h"
 
#include <string>

class SOSM_EXPORT SOSM_SpectralObject
{
public:
   enum Status
   {
      cOK = 0,
      cINCOMPATIBLE_INCREMENTS,
      cINCOMPATIBLE_ORIGINS
   };
 
   static std::string StatusString(Status aStatus);
 
   SOSM_SpectralObject()
      : mOrigin(0.0F)
      , mIncrement(0.0F)
      , mCount(0)
      , mLowerWavelength(0.0F)
      , mUpperWavelength(0.0F)
   {
   }
 
   SOSM_SpectralObject(float aOrigin, float aIncrement, int aCount)
      : mOrigin(aOrigin)
      , mIncrement(aIncrement)
      , mCount(aCount)
      , mLowerWavelength(0.0F)
      , mUpperWavelength(0.0F)
   {
      UpdateWavelengthLimits();
   }
 
   virtual ~SOSM_SpectralObject() {}
 
   // Using default copy constructor
   // Using default assignment operator

   float Origin() const { return mOrigin; }

   float Increment() const { return mIncrement; }

   int Count() const { return mCount; }

   void DefineSpectralLimits(float aOrigin, float aIncrement, int aCount)
   {
      mOrigin    = aOrigin;
      mIncrement = aIncrement;
      mCount     = aCount;
      UpdateWavelengthLimits();
   }

   void DefineSpectralLimits(const SOSM_SpectralObject& aSource)
   {
      mOrigin          = aSource.mOrigin;
      mIncrement       = aSource.mIncrement;
      mCount           = aSource.mCount;
      mLowerWavelength = aSource.mLowerWavelength;
      mUpperWavelength = aSource.mUpperWavelength;
   }

   bool Equals(const SOSM_SpectralObject& aRhs) const
   {
      return ((mOrigin == aRhs.mOrigin) && (mIncrement == aRhs.mIncrement) && (mCount == aRhs.mCount));
   }
 
   Status Union(const SOSM_SpectralObject& aObject);
 
   Status Union(const SOSM_SpectralObject& aObject1, const SOSM_SpectralObject& aObject2);


 
   // Return the actual lower wavelength (um).
   float LowerWavelength() const { return mLowerWavelength; }
   // Return the actual upper wavelength (um).
   float UpperWavelength() const { return mUpperWavelength; }
 
   // Set the actual lower and upper wavelengths (um).
   void SetWavelengthLimits(float aLowerWavelength, float aUpperWavelength)
   {
      mLowerWavelength = aLowerWavelength;
      mUpperWavelength = aUpperWavelength;
   }

private:
   void UpdateWavelengthLimits();
 
   float mOrigin;
   float mIncrement;
   int   mCount;
   float mLowerWavelength;
   float mUpperWavelength;
};
 
#endif