1                 : /******************************************************************************
       2                 :  *
       3                 :  * Purpose:  Primary public include file for PCIDSK SDK.
       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                 :  
      28                 : #ifndef __INCLUDE_SEGMENT_PCIDSKSEGMENT_H
      29                 : #define __INCLUDE_SEGMENT_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             163 :     {
      46                 :     public:
      47             163 :         virtual ~PCIDSKSegment() {}
      48                 : 
      49              27 :         virtual void Initialize() {}
      50                 : 
      51                 :         virtual void WriteToFile( const void *buffer, uint64 offset, uint64 size)=0;
      52                 :         virtual void ReadFromFile( void *buffer, uint64 offset, uint64 size ) = 0;
      53                 : 
      54                 :         virtual eSegType    GetSegmentType() = 0;
      55                 :         virtual std::string GetName() = 0;
      56                 :         virtual std::string GetDescription() = 0;
      57                 :         virtual int         GetSegmentNumber() = 0;
      58                 :         virtual uint64      GetContentSize() = 0;
      59                 :         virtual bool        IsAtEOF() = 0;
      60                 : 
      61                 :         virtual void        SetDescription( const std::string &description) = 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 std::vector<std::string> GetHistoryEntries() const = 0;
      68                 :         virtual void SetHistoryEntries( const std::vector<std::string> &entries ) = 0;
      69                 :         virtual void PushHistory(const std::string &app,
      70                 :                                  const std::string &message) = 0;
      71                 : 
      72                 :         virtual void Synchronize() = 0;
      73                 : 
      74                 :         virtual std::string ConsistencyCheck() = 0;
      75                 :     };
      76                 : 
      77                 : } // end namespace PCIDSK
      78                 : 
      79                 : #endif // __INCLUDE_SEGMENT_PCIDSKSEGMENT_H