Line_Cache.hh

Go to the documentation of this file.

/*  HiRISE Line Cache

PIRL CVS ID: Line_Cache.hh,v 1.8 2020/02/14 01:17:18 schaller Exp

Copyright (C) 2005-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#ifndef _HiRISE_Line_Cache_
#define _HiRISE_Line_Cache_

//  UA::HiRISE
#include    "Image_Line.hh"

//  PIRL
#include    "Cache.hh"

#include    <iosfwd>
#include    <sstream>
#include    <string>

namespace UA
{
namespace HiRISE
{
/*******************************************************************************
    Line_Cache
*/
class Line_Cache
:   public Image_Line,
    public PIRL::Cache
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

/*==============================================================================
    Constructors
*/
Line_Cache
    (
    Image_Line&     image_line,
    std::istream&   stream
    );

private:
Line_Cache ();
Line_Cache (const Line_Cache&);
Line_Cache& operator= (const Line_Cache&);

public:
/*==============================================================================
    Accessors
*/
virtual unsigned long long bytes_read () const
    {return Cache::bytes_read ();}

unsigned long long source_bytes () const
    {return Data_Bytes;}

virtual bool compressed_data () const
    {return false;}

virtual unsigned long long compressed_bytes () const
    {return 0;}

virtual unsigned long long decompressed_bytes () const
    {return 0;}

unsigned int count () const
    {return Line_Count;}

virtual Line_Cache& source (std::istream& stream);

virtual std::istream& source () const
    {return Cache::source ();}

std::string bad_line_description () const;

bool synchronization_lost ()
    {return Synchronization_Lost;}

/*==============================================================================
    Manipulators
*/
bool next_line ();

virtual bool refill (unsigned long max_amount = (unsigned long)-1);

virtual void reset ();

/*==============================================================================
    Helpers
*/
private:
char* patch
    (char* begin = NULL, char* end = NULL);

protected:

unsigned long long offset (char* location) const
{return bytes_read () - amount_used () + location - start ();}

/*==============================================================================
    Cache Management
*/
protected:

Image_Line
    *Line;

unsigned long long
    Data_Bytes;

unsigned int
    Line_Count;

unsigned int
    Next_Line_Number;

bool
    Synchronization_Lost;

std::ostringstream
    Bad_Line_Description;

std::string
    Next_Bad_Line_Description;

};  //  class Line_Cache

}   //  namespace HiRISE
}   //  namespace UA
#endif