KSquare Utilities
ScannerFileSimple.h
Go to the documentation of this file.
1 #if !defined(_SCANNERFILESIMPLE_)
2 #define _SCANNERFILESIMPLE_
3 
4 
5 namespace KKLSC
6 {
7  /**
8  *@class KKLSC::ScannerFileSimple ScannerFileSimple.h A simple format where each scan line is stored without any encoding or compression.
9  */
10 
12  {
13  public:
14  /** Constructor for opening file for reading */
15  ScannerFileSimple (const KKStr& _fileName,
16  RunLog& _log
17  );
18 
19 
20  /** Constructor for opening file for Writing */
21  ScannerFileSimple (const KKStr& _fileName,
22  kkuint32 _pixelsPerScanLine,
23  kkuint32 _frameHeight,
24  RunLog& _log
25  );
26 
27  virtual
29 
30  virtual Format FileFormat () const {return Format::sfSimple;}
31 
32  virtual
33  void WriteTextBlock (const uchar* txtBlock,
34  kkuint32 txtBlockLen
35  );
36 
37  static
38  const uchar* CompensationTable ();
39 
40 
41  protected:
42  virtual
44 
45  virtual
47 
48 
49  virtual
50  void WriteBufferFrame ();
51 
52  };
53 }
54 
55 
56 #endif
virtual Format FileFormat() const
static const uchar * CompensationTable()
virtual void WriteTextBlock(const uchar *txtBlock, kkuint32 txtBlockLen)
virtual void WriteBufferFrame()
Write the contents of 'frameBuffer' to he end of the scanner file.
unsigned __int32 kkuint32
Definition: KKBaseTypes.h:89
__int64 kkint64
Definition: KKBaseTypes.h:90
ScannerFileSimple(const KKStr &_fileName, kkuint32 _pixelsPerScanLine, kkuint32 _frameHeight, RunLog &_log)
virtual kkint64 SkipToNextFrame()
Skip to start of next frame returning back byte offset of that frame.
unsigned char uchar
Unsigned character.
Definition: KKBaseTypes.h:77
static KKStr Concat(const std::vector< std::string > &values)
Concatenates the list of &#39;std::string&#39; strings.
Definition: KKStr.cpp:1082
Contains Classes that are specific to Cameras physical characteristics.
Used for logging messages.
Definition: RunLog.h:49
ScannerFileSimple(const KKStr &_fileName, RunLog &_log)
virtual kkuint32 ReadBufferFrame()
Read in one Scanner File Frame return number of actual scan-lines read.