1                 : /******************************************************************************
       2                 :  *
       3                 :  * Purpose:  Declaration of the PCIDSKChannel interface.
       4                 :  * 
       5                 :  ******************************************************************************
       6                 :  * Copyright (c) 2009
       7                 :  * PCI Geomatics, 50 West Wilmot Street, Richmond Hill, Ont, Canada
       8                 :  *
       9                 :  * Permission is hereby granted, free of charge, to any person obtaining a
      10                 :  * copy of this software and associated documentation files (the "Software"),
      11                 :  * to deal in the Software without restriction, including without limitation
      12                 :  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
      13                 :  * and/or sell copies of the Software, and to permit persons to whom the
      14                 :  * Software is furnished to do so, subject to the following conditions:
      15                 :  *
      16                 :  * The above copyright notice and this permission notice shall be included
      17                 :  * in all copies or substantial portions of the Software.
      18                 :  *
      19                 :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
      20                 :  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      21                 :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
      22                 :  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      23                 :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
      24                 :  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
      25                 :  * DEALINGS IN THE SOFTWARE.
      26                 :  ****************************************************************************/
      27                 : #ifndef __INCLUDE_PCIDSK_CHANNEL_H
      28                 : #define __INCLUDE_PCIDSK_CHANNEL_H
      29                 : 
      30                 : #include "pcidsk_types.h"
      31                 : #include <string>
      32                 : #include <vector>
      33                 : 
      34                 : namespace PCIDSK
      35                 : {
      36                 : /************************************************************************/
      37                 : /*                            PCIDSKChannel                             */
      38                 : /************************************************************************/
      39                 : 
      40                 : //! Interface to one PCIDSK channel (band) or bitmap segment.
      41                 : 
      42                 :     class PCIDSK_DLL PCIDSKChannel 
      43             242 :     {
      44                 :     public:
      45             242 :         virtual ~PCIDSKChannel() {};
      46                 :         virtual int GetBlockWidth() const = 0;
      47                 :         virtual int GetBlockHeight() const = 0;
      48                 :         virtual int GetBlockCount() const = 0;
      49                 :         virtual int GetWidth() const = 0;
      50                 :         virtual int GetHeight() const = 0;
      51                 :         virtual eChanType GetType() const = 0;
      52                 :         virtual int ReadBlock( int block_index, void *buffer,
      53                 :             int win_xoff=-1, int win_yoff=-1,
      54                 :             int win_xsize=-1, int win_ysize=-1 ) = 0;
      55                 :         virtual int WriteBlock( int block_index, void *buffer ) = 0;
      56                 :         virtual int GetOverviewCount() = 0;
      57                 :         virtual PCIDSKChannel *GetOverview( int i ) = 0;
      58                 :         virtual bool IsOverviewValid( int i ) = 0;
      59                 :         virtual std::string GetOverviewResampling( int i ) = 0;
      60                 :         virtual void SetOverviewValidity( int i, bool validity ) = 0;
      61                 :         virtual std::vector<int> GetOverviewLevelMapping() const = 0;
      62                 : 
      63                 :         virtual std::string GetMetadataValue( const std::string &key ) const = 0;
      64                 :         virtual void SetMetadataValue( const std::string &key, const std::string &value ) = 0;
      65                 :         virtual std::vector<std::string> GetMetadataKeys() const = 0;
      66                 : 
      67                 :         virtual void Synchronize() = 0;
      68                 : 
      69                 :         virtual std::string GetDescription() = 0;
      70                 :         virtual void SetDescription( const std::string &description ) = 0;
      71                 : 
      72                 :         virtual std::vector<std::string> GetHistoryEntries() const = 0;
      73                 :         virtual void SetHistoryEntries( const std::vector<std::string> &entries ) = 0;
      74                 :         virtual void PushHistory(const std::string &app,
      75                 :                                  const std::string &message) = 0;
      76                 :     };
      77                 : } // end namespace PCIDSK
      78                 : 
      79                 : #endif // __INCLUDE_PCIDSK_CHANNEL_H