rvc/spectrallibrary.h

Go to the documentation of this file.

#ifndef INC_RVC_SPECTRALLIBRARY_H
#define INC_RVC_SPECTRALLIBRARY_H

#ifndef INC_RVC_OBJECT_H
   #include <rvc/object.h>
#endif


namespace RVC {
#ifndef GENERATING_DOXYGEN_OUTPUT
   class SPECTRALLIBRARYHANDLE;
#endif // GENERATING_DOXYGEN_OUTPUT

class SPECTRALLIBRARY : public RVC::OBJECT {
   public:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      struct RECORD;
      struct CHANNEL;
      #endif // GENERATING_DOXYGEN_OUTPUT

      SPECTRALLIBRARY (
         );

      SPECTRALLIBRARY (
         const RVC::SPECTRALLIBRARY& obj
         );

      virtual ~SPECTRALLIBRARY (
         );

      RVC::SPECTRALLIBRARY& operator= (
         const RVC::SPECTRALLIBRARY& rhs
         );

      INT32 AddRecord (
         const RECORD& record                      
         );

      ERRVALUE DeleteRecord (
         INT32 RecordNum                           
         );
         
      INT32 GetMaxNumChannels (
         );
         
      double GetMaxWavelength (
         );
         
      INT32 GetMinNumChannels (
         );
         
      double GetMinWavelength (
         );
         
      INT32 GetNumRecords (
         );

      ERRVALUE Make (
         const RVC::OBJECT& parent,    
         const RVC::DESCRIPTOR& Descriptor,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Make (
         RVC::OBJITEM& ObjItem,  
#ifdef RVC_CREDENTIALS_MANDATORY
         const char* Source,        
         const CREDENTIALS* Credentials 
#else
         const char* Source = 0,       
         const CREDENTIALS* Credentials = 0           
#endif
         );

      ERRVALUE ReadRecord (
         INT32 RecordNum,                          
         RECORD& record                   
         );

      ERRVALUE ReadRecordChannels (
         INT32 RecordNum,                          
         SIMPLE_ARRAY<CHANNEL>& Channels  
         );

      ERRVALUE WriteRecord (
         INT32 RecordNum,                          
         RECORD& record                   
         );

      ERRVALUE WriteRecordChannels (
         INT32 RecordNum,                                
         const SIMPLE_ARRAY<CHANNEL>& Channels  
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      virtual ERRVALUE v_CloseObject ();
      virtual OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent, const CREDENTIALS* Credentials);

      SPECTRALLIBRARYHANDLE* m_SpectralLibraryHandle;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


struct SPECTRALLIBRARY::CHANNEL {
   FLOAT wavelength;                   
   FLOAT bandwidth;                    
   FLOAT error;                        
   FLOAT value;                        
   };

#define SPECTRUM_TITLE_SIZE         66
#define SPECTRUM_HISTORY_SIZE       66
#define SPECTRUM_USERNAME_SIZE      16

struct SPECTRALLIBRARY::RECORD {
   FIXEDSTRING<SPECTRUM_TITLE_SIZE> Title;   
   FIXEDSTRING<SPECTRUM_HISTORY_SIZE> History;
   FIXEDSTRING<SPECTRUM_USERNAME_SIZE> Username;
   RVCDATETIME ProcDate;               
   RVCDATETIME ProcDataTime;           
   RVCDATETIME StartDataTime;          
   DOUBLE RightAscention;              
   DOUBLE DeclinationCoord;            
   DOUBLE IncidentAngle;               
   DOUBLE EmissionAngle;               
   DOUBLE PhaseAngle;                  
   DOUBLE SampleBeam;                  
   DOUBLE OneScanTime;                 
   DOUBLE IntegrationTime;             
   DOUBLE Temperature;                 
   DOUBLE AthmosphericThickness;       
   DOUBLE MinWavelength;               
   DOUBLE MaxWavelength;               
   INT32 IndepSpectRuns;               
   INT32 WeightNumRuns;                
   INT32 NormChannels[2];              
   
   RECORD (
      ) { memset(this, 0, sizeof(*this)); }
      
   };

}     // End of RVC namespace

#endif         // INC_RVC_SPECTRALLIBRARY_H

---