WXP::File Class Reference
[File I/O objects]

This class accesses files. More...

#include "../include/File.h"

Inheritance diagram for WXP::File:
WXP::FileAttr

List of all members.

Public Types

enum  Type {
  REG, PIPE, STDIO, FIFO,
  DEVICE, SOCKETC, SOCKETS, HTTP,
  FTP
}
enum  Format {
  UNK, WXP, NETCDF, GRIB,
  BUFR, UNISYS, NONE
}

Public Member Functions

int init ()
 File (const char *file, const char *raccess)
 File (String &file, const char *raccess)
 File (const char *file, int raccess)
 File ()
 ~File ()
int open (const char *file, const char *raccess)
int open (String &file, const char *raccess)
int open (const char *file, int raccess)
int getLine (char *string, int len)
int getLine (String &string)
int skipLine ()
bool isOpen ()
int rewind ()
int close ()
bool endFile ()
int scanf (const char *fmt,...)
int printf (const char *fmt,...)
int read (unsigned char *buf, int size, int num)
int read (unsigned char *buf, int size)
int read (Buffer &buf, int size)
int read (Buffer &buf)
int write (const unsigned char *buf, int size, int num)
int write (const unsigned char *buf, int size)
int tell ()
int seek (int byte, int where)
int seek (int byte)
FILE * getFP ()

Static Public Member Functions

static int setShare (int mode)

Static Public Attributes

static const int FILE_LENGTH = 100

Detailed Description

This class accesses files.

Author:
Dan Vietor

Constructor & Destructor Documentation

File::File ( const char *  file,
const char *  raccess 
)

Constructor. Opens file with access

Parameters:
file Filename to open
raccess File access (r, w, a, r+, see fopen)

References open().

File::File ( String &  file,
const char *  raccess 
)

Constructor. Opens file with access

Parameters:
file Filename to open
access File access (r, w, a, r+, see fopen)

References WXP::String::get(), and open().

File::File ( const char *  file,
int  raccess 
)

Constructor. Opens file with access

Parameters:
file Filename to open
raccess File access READ, WRITE, APPEND

References open().

File::File (  ) 

Constructor. Initializes class data

References init().

File::~File (  ) 

Destructor. Closes file

References close().

Member Function Documentation

int File::close (  ) 

Closes the file

Referenced by WXP::ImageFile::checkType(), WXP::GridFile::checkType(), WXP::GribFile::checkType(), WXP::BufrFile::checkType(), WXP::WatchFile::close(), WXP::TiffFile::close(), WXP::SfcWxpFile::close(), WXP::SfcUniFile::close(), WXP::SatUniFile::close(), WXP::SatFile::close(), WXP::ResrcFile::close(), WXP::RcmFile::close(), WXP::Parse::close(), WXP::NowradFile::close(), WXP::NidsFile::close(), WXP::MetarFile::close(), WXP::MapFile::close(), WXP::LritFile::close(), WXP::Lev2File::close(), WXP::KavradFile::close(), WXP::ImgWxpFile::close(), WXP::GridWxpFile::close(), WXP::GribFile::close(), WXP::GiniFile::close(), WXP::GifFile::close(), WXP::CityFile::close(), WXP::BufrFile::close(), WXP::AreaFile::close(), WXP::RedbookPlot::draw(), WXP::ModelName::get(), WXP::NidsFile::open(), WXP::ImgWxpFile::open(), WXP::Message::print(), WXP::ImgWxpFile::readData(), WXP::PngFile::write(), WXP::ImgWxpFile::write(), WXP::GifFile::write(), ~File(), WXP::GridWxpFile::~GridWxpFile(), WXP::Message::~Message(), WXP::MetarFile::~MetarFile(), WXP::ResrcFile::~ResrcFile(), WXP::SfcUniFile::~SfcUniFile(), and WXP::SfcWxpFile::~SfcWxpFile().

bool File::endFile (  ) 

Checks for end of file

Returns:
True if end of file

Referenced by WXP::SfcWxpFile::read(), WXP::SfcUniFile::read(), WXP::RcmFile::read(), WXP::NidsFile::readBytes(), WXP::NowradFile::readLine(), WXP::NowradFile::readPacket(), WXP::KavradFile::readPacket(), and WXP::ModelSpec::set().

int File::getLine ( String &  string  ) 

Gets a line from the file

Return values:
string Output string class

References getLine().

int File::getLine ( char *  string,
int  len 
)

Gets a line from the file

Return values:
string Output string
Parameters:
len Length of string

Referenced by WXP::RedbookPlot::draw(), WXP::ResrcFile::get(), WXP::ModelName::get(), WXP::GribFile::getHeader(), WXP::Parse::getLine(), WXP::MetarFile::getLine(), getLine(), WXP::SfcWxpFile::open(), WXP::RcmFile::read(), WXP::GribFile::read(), WXP::CityFile::read(), WXP::ColorFile::readFile(), WXP::ImgWxpFile::readHeader(), WXP::GribFile::readHeader(), WXP::GiniFile::readHeader(), WXP::BufrFile::readHeader(), WXP::ModelSpec::set(), WXP::Graph::setFont(), and WXP::Parse::setLoc().

int File::init (  ) 

Initializes the class data

References WXP::FileAttr::READ.

Referenced by File(), and open().

bool File::isOpen (  ) 

Checks to see if file is open

Returns:
True if open

Referenced by WXP::UpaWmoFile::checkType(), WXP::SfcXmlFile::checkType(), WXP::SfcWxpFile::checkType(), WXP::SfcWmoFile::checkType(), WXP::SfcFile::checkType(), WXP::SfcCdfFile::checkType(), WXP::SatFile::checkType(), WXP::ImageFile::checkType(), WXP::GridFile::checkType(), WXP::GribFile::checkType(), WXP::BufrFile::checkType(), WXP::ModelName::get(), WXP::WatchFile::open(), WXP::UpaWmoFile::open(), WXP::TiffFile::open(), WXP::SfcWxpFile::open(), WXP::SfcWmoFile::open(), WXP::SfcUniFile::open(), WXP::SfcFile::open(), WXP::SatUniFile::open(), WXP::ResrcFile::open(), WXP::Parse::open(), WXP::NowradFile::open(), WXP::NidsFile::open(), WXP::MetarFile::open(), WXP::MapFile::open(), WXP::LritFile::open(), WXP::Lev2File::open(), WXP::KavradFile::open(), WXP::ImgWxpFile::open(), WXP::GridWxpFile::open(), WXP::GribFile::open(), WXP::GiniFile::open(), WXP::GifFile::open(), WXP::CityFile::open(), WXP::BufrFile::open(), WXP::AreaFile::open(), WXP::Message::print(), WXP::SatUniFile::read(), WXP::ImgWxpFile::read(), WXP::GiniFile::read(), WXP::SatUniFile::readData(), WXP::ImgWxpFile::readData(), WXP::GiniFile::readData(), WXP::ColorFile::readFile(), WXP::SatUniFile::readHeader(), WXP::GiniFile::readHeader(), WXP::ModelSpec::set(), WXP::Graph::setFont(), WXP::ImgWxpFile::write(), and WXP::Message::~Message().

int File::open ( const char *  file,
int  raccess 
)

Opens file with access

Parameters:
file Filename to open
raccess File access READ, WRITE, APPEND

References WXP::FileAttr::APPEND, open(), WXP::FileAttr::READ, and WXP::FileAttr::WRITE.

int File::open ( String &  file,
const char *  raccess 
)

Opens file with access

Parameters:
file Filename to open
access File access (r, w, a, r+, see fopen)

References WXP::String::get(), and open().

int File::open ( const char *  file,
const char *  raccess 
)

Opens file with access

Parameters:
file Filename to open
access File access (r, w, a, r+, see fopen)

References WXP::FileTool::addUserPath(), WXP::Wxp::exit(), WXP::String::get(), WXP::StrLib::iequal(), init(), WXP::FileTool::isStdio(), WXP::FileTool::makeDir(), WXP::Wxp::NORUN, printf(), WXP::FileAttr::READ, WXP::Wxp::validLicense(), and WXP::FileAttr::WRITE.

Referenced by WXP::GribFile::checkType(), WXP::BufrFile::checkType(), WXP::RedbookPlot::draw(), File(), WXP::ModelName::get(), WXP::WatchFile::open(), WXP::UpaWmoFile::open(), WXP::TiffFile::open(), WXP::SfcWxpFile::open(), WXP::SfcWmoFile::open(), WXP::SfcUniFile::open(), WXP::SfcFile::open(), WXP::SatUniFile::open(), WXP::SatFile::open(), WXP::ResrcFile::open(), WXP::Parse::open(), WXP::NowradFile::open(), WXP::NidsFile::open(), WXP::MetarFile::open(), WXP::MapFile::open(), WXP::LritFile::open(), WXP::Lev2File::open(), WXP::KavradFile::open(), WXP::ImgWxpFile::open(), WXP::GridWxpFile::open(), WXP::GribFile::open(), WXP::GiniFile::open(), WXP::GifFile::open(), open(), WXP::CityFile::open(), WXP::BufrFile::open(), WXP::AreaFile::open(), WXP::Message::print(), WXP::ModelSpec::set(), WXP::Message::set(), and WXP::Graph::setFont().

int File::printf ( const char *  fmt,
  ... 
)

Prints formatted data to file (see fprintf)

Parameters:
fmt Printf format to use
... Variables to format

Referenced by WXP::SfcWxpFile::open(), WXP::SfcUniFile::open(), open(), WXP::Message::print(), WXP::ImgWxpFile::write(), and WXP::MapFile::writeHeader().

int File::read ( unsigned char *  buf,
int  size 
)

Reads a set number of values from file (see fread)

Return values:
buf Output byte buffer
Parameters:
size Number of bytes
int File::read ( unsigned char *  buf,
int  size,
int  num 
)

Reads a set number of values from file (see fread)

Return values:
buf Output byte buffer
Parameters:
size Size of each value in bytes
num Number of values

Referenced by WXP::ImageFile::checkType(), WXP::GridFile::checkType(), WXP::GribFile::checkType(), WXP::BufrFile::checkType(), WXP::SfcUniFile::open(), WXP::ImgWxpFile::open(), WXP::TiffFile::read(), WXP::GifFile::read(), WXP::GribFile::readBits(), WXP::GribFile::readBMB(), WXP::GribFile::readBMS(), WXP::AreaFile::readByte(), WXP::NidsFile::readBytes(), WXP::SatUniFile::readData(), WXP::ImgWxpFile::readData(), WXP::GribFile::readData(), WXP::GiniFile::readData(), WXP::AreaFile::readData(), WXP::GribFile::readDS(), WXP::SatUniFile::readHeader(), WXP::NowradFile::readHeader(), WXP::KavradFile::readHeader(), WXP::GiniFile::readHeader(), WXP::AreaFile::readHeader(), WXP::NowradFile::readLine(), WXP::NowradFile::readPacket(), WXP::KavradFile::readPacket(), WXP::AreaFile::readWord(), and WXP::NidsFile::skipLine().

int File::rewind (  ) 

Rewinds the file

Referenced by WXP::SfcWxpFile::rewind(), WXP::SatUniFile::rewind(), WXP::SatFile::rewind(), WXP::Parse::rewind(), WXP::NowradFile::rewind(), WXP::MetarFile::rewind(), WXP::MapFile::rewind(), WXP::KavradFile::rewind(), WXP::GiniFile::rewind(), WXP::CityFile::rewind(), WXP::AreaFile::rewind(), and WXP::Parse::setLoc().

int File::scanf ( const char *  fmt,
  ... 
)

Scans file for data (see fscanf)

Parameters:
fmt Scanf format to use
Return values:
... Output variables

Referenced by WXP::UpaWmoFile::checkType(), WXP::SfcXmlFile::checkType(), WXP::SfcWxpFile::checkType(), WXP::SfcWmoFile::checkType(), WXP::SfcFile::checkType(), WXP::SfcCdfFile::checkType(), WXP::SatFile::checkType(), WXP::SfcWxpFile::read(), WXP::ImgWxpFile::readData(), WXP::SatUniFile::readHeader(), WXP::NowradFile::readHeader(), WXP::MapFile::readHeader(), and WXP::ImgWxpFile::readHeader().

int File::seek ( int  byte,
int  where 
)

Seeks to a specific location in a file

Parameters:
byte Offset in file to seek to
where Where to offset from (0=begin, 1=current, 2=end)

Referenced by WXP::GribFile::getHeader(), WXP::Parse::getLine(), WXP::GribFile::next(), WXP::TiffFile::read(), WXP::GribFile::read(), WXP::KavradFile::readHeader(), WXP::AreaFile::readHeader(), WXP::NowradFile::readPacket(), WXP::SfcUniFile::rewind(), WXP::MapFile::seek(), WXP::Parse::setLoc(), and WXP::GribFile::skipSection().

int File::setShare ( int  mode  )  [static]

Sets the share mode for file

Parameters:
mode 1=shared, 0=not shared
int File::skipLine (  ) 

Skips a line in the file

Referenced by WXP::SfcWxpFile::open(), WXP::SfcWxpFile::read(), WXP::GribFile::readHeader(), WXP::BufrFile::readHeader(), WXP::SfcWxpFile::rewind(), WXP::SatUniFile::rewind(), WXP::SatFile::rewind(), and WXP::GiniFile::rewind().

int File::tell (  ) 

Returns the current location in file

Returns:
Byte offset

Referenced by WXP::Parse::getLine(), WXP::SfcWxpFile::open(), WXP::TiffFile::read(), WXP::SfcWxpFile::read(), WXP::GribFile::readBits(), WXP::NidsFile::readBytes(), WXP::SatUniFile::readData(), WXP::GribFile::readData(), WXP::GribFile::readHeader(), WXP::BufrFile::readHeader(), and WXP::Parse::setLoc().

int File::write ( const unsigned char *  buf,
int  size 
)

Writes a set number of values to file (see fwrite)

Parameters:
buf Input byte buffer
size Number of bytes
int File::write ( const unsigned char *  buf,
int  size,
int  num 
)

Writes a set number of values to file (see fwrite)

Parameters:
buf Input byte buffer
size Size of each value in bytes
num Number of values

Referenced by WXP::ImgWxpFile::write(), and WXP::GifFile::write().

The documentation for this class was generated from the following files:
Generated on 8 Jan 2010 for WXP C++ Library by  doxygen 1.6.1