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