Line data    Source code

       1             : /******************************************************************************
       2             :  *
       3             :  * Purpose:  Primary public include file for PCIDSK SDK.
       4             :  *
       5             :  ******************************************************************************
       6             :  * Copyright (c) 2009
       7             :  * PCI Geomatics, 90 Allstate Parkway, Markham, Ontario, 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             : 
      28             : #ifndef INCLUDE_PCIDSKSEGMENT_H
      29             : #define INCLUDE_PCIDSKSEGMENT_H
      30             : 
      31             : #include "pcidsk_config.h"
      32             : #include "pcidsk_types.h"
      33             : #include <string>
      34             : #include <vector>
      35             : 
      36             : namespace PCIDSK
      37             : {
      38             : /************************************************************************/
      39             : /*                            PCIDSKSegment                             */
      40             : /************************************************************************/
      41             : 
      42             : //! Public interface for the PCIDSK Segment Type
      43             : 
      44             :     class PCIDSKSegment
      45             :     {
      46             :     public:
      47        1463 :         virtual ~PCIDSKSegment() {}
      48             : 
      49          41 :         virtual void Initialize() {}
      50             : 
      51             :         virtual void LoadSegmentPointer( const char *segment_pointer ) = 0;
      52             : 
      53             :         virtual void WriteToFile( const void *buffer, uint64 offset, uint64 size)=0;
      54             :         virtual void ReadFromFile( void *buffer, uint64 offset, uint64 size ) = 0;
      55             : 
      56             :         virtual eSegType    GetSegmentType() = 0;
      57             :         virtual std::string GetName() = 0;
      58             :         virtual std::string GetDescription() = 0;
      59             :         virtual int         GetSegmentNumber() = 0;
      60             :         virtual bool        IsContentSizeValid() const = 0;
      61             :         virtual uint64      GetContentSize() = 0;
      62             :         virtual uint64      GetContentOffset() = 0;
      63             :         virtual bool        IsAtEOF() = 0;
      64             :         virtual bool        CanExtend(uint64 size) const = 0;
      65             : 
      66             :         virtual void        SetDescription( const std::string &description) = 0;
      67             : 
      68             :         virtual std::string GetMetadataValue( const std::string &key ) const = 0;
      69             :         virtual void SetMetadataValue( const std::string &key, const std::string &value ) = 0;
      70             :         virtual std::vector<std::string> GetMetadataKeys() const = 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             :         virtual void Synchronize() = 0;
      78             : 
      79             :         virtual std::string ConsistencyCheck() = 0;
      80             :     };
      81             : 
      82             : } // end namespace PCIDSK
      83             : 
      84             : #endif // INCLUDE_PCIDSKSEGMENT_H