Line data    Source code

       1             : /******************************************************************************
       2             :  *
       3             :  * Purpose:  PCIDSK TEXt segment interface class.
       4             :  *
       5             :  ******************************************************************************
       6             :  * Copyright (c) 2010
       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             : #ifndef INCLUDE_PCIDSK_TEX_H
      28             : #define INCLUDE_PCIDSK_TEX_H
      29             : 
      30             : #include <string>
      31             : #include <vector>
      32             : 
      33             : namespace PCIDSK
      34             : {
      35             : /************************************************************************/
      36             : /*                              PCIDSK_TEX                              */
      37             : /************************************************************************/
      38             : 
      39             : //! Interface to PCIDSK text segment.
      40             : 
      41             :     class PCIDSK_DLL PCIDSK_TEX
      42             :     {
      43             :     public:
      44           0 :         virtual ~PCIDSK_TEX() {}
      45             : 
      46             : /**
      47             : \brief Read a text segment (SEG_TEX).
      48             : 
      49             : All carriage returns in the file are converted to newlines during reading.  No other processing is done.
      50             : 
      51             : @return a string containing the entire contents of the text segment.
      52             : 
      53             : */
      54             :         virtual std::string ReadText() = 0;
      55             : 
      56             : /**
      57             : \brief Write a text segment.
      58             : 
      59             : Writes the text to the text segment.  All newlines will be converted to
      60             : carriage controls for storage in the text segment per the normal text segment
      61             : conventions, and if missing a carriage return will be added to the end of the
      62             : file.
      63             : 
      64             : @param text the text to write to the segment.  May contain newlines, and other special characters but no embedded \0 characters.
      65             : 
      66             : */
      67             :         virtual void WriteText( const std::string &text ) = 0;
      68             :     };
      69             : } // end namespace PCIDSK
      70             : 
      71             : #endif // INCLUDE_PCIDSK_TEX_H