InFile Class Reference

#include <InStreams.h>

Inheritance diagram for InFile:

PhysicalInStream InStream< InFile, InBinary > InStream< InFile, InConfig > InStream< InFile, InText > InBinaryFile InConfigFile InTextFile List of all members.

Public Member Functions

 InFile ()
 ~InFile ()
virtual bool exists () const
virtual bool getEof () const

Protected Member Functions

void open (const char *name)
virtual void readFromStream (void *p, int size)

Private Attributes

Filestream

Detailed Description

An PhysicalInStream that reads the data from a file.

Definition at line 653 of file InStreams.h.


Constructor & Destructor Documentation

InFile::InFile (  )  [inline]

Default constructor

Definition at line 660 of file InStreams.h.

InFile::~InFile (  )  [inline]

Destructor

Definition at line 663 of file InStreams.h.

References stream.


Member Function Documentation

virtual bool InFile::exists (  )  const [inline, virtual]

The function states whether the file actually exists.

Returns:
Does the file exist?

Reimplemented from PhysicalInStream.

Definition at line 669 of file InStreams.h.

References File::exists(), and stream.

Referenced by RoboCupCtrl::adaptColors(), BoxSpecialist::BoxSpecialist(), ChallengeSymbols::ChallengeSymbols(), RoboCupCtrl::connect(), DefaultTacticChooser::DefaultTacticChooser(), RoboCupCtrl::getSenderName(), GT2004BasicBehaviorEvolveOmniParameters::GT2004BasicBehaviorEvolveOmniParameters(), CMofTesterDlgBar::handleCommand(), GTXabsl2Profiler::importLogFile(), CCameraParametersToolBar::Init(), Logger::init(), Debug::init(), LinesTables2004::LinesTables2004(), RobotConfiguration::load(), KickSelectionTable::load(), IniFile::load(), GT2004ParametersSet::load(), ColorCorrector::load(), CKickEditorDlgBar::loadCaseBaseLogfile(), EMGaussianMixture::loadLookupTable(), PanoramaLocator::loadPanorama(), BB2004InvKinWalkingEngine::loadParameters(), CSettingsDlgBar::loadSettings(), GT2004SoundControl::loadWavefile(), PanoramaHistogramDistribution::loadWorldModel(), Location::Location(), Logger::main(), CRobotRemoteApp::onChangeConfiguration(), CKickEditorDlgBar::OnContextMenu(), CColorTable64DlgBar::OnCt64Open(), CColorTable64DlgBar::OnInitDialog(), CKickEditorDlgBar::OnOpen(), CTSLColorTableToolDlgBar::OnTSLColorTableToolLoad(), CInvKinParametersDlgBar::OnWalkParamLoad(), LogPlayer::open(), RBallSpecialist2::RBallSpecialist2(), RDefaultStrategy::RDefaultStrategy(), GT2003MotionNetSpecialActions::readOdometryTable(), InvKinWalkingParameters::readValues(), CXabsl2DlgBar::reload(), RobotConsole::RobotConsole(), Router::Router(), CXabsl2DlgBar::sendIntermediateCode(), Sensors::Sensors(), SolutionRequest::setDefaultSolutions(), ColorTableTSLMod::setup(), ColorTable64Mod::setup(), ColorTable32KMod::setup(), VariableLighting::VariableLighting(), CPing::WIN32GetMAC(), and RobotConsole::xabslLoadBehavior().

virtual bool InFile::getEof (  )  const [inline, virtual]

The function states whether the end of the file has been reached.

Returns:
End of file reached?

Implements PhysicalInStream.

Definition at line 676 of file InStreams.h.

References File::eof(), and stream.

Referenced by GTXabsl2Profiler::importLogFile(), and IniFile::load().

void InFile::open ( const char *  name  )  [inline, protected]

opens the file.

Parameters:
name The name of the file to open. It will be interpreted as relative to the configuration directory.

Definition at line 685 of file InStreams.h.

References stream.

Referenced by InBinaryFile::InBinaryFile(), InConfigFile::InConfigFile(), and InTextFile::InTextFile().

virtual void InFile::readFromStream ( void *  p,
int  size 
) [inline, protected, virtual]

The function reads a number of bytes from the file.

Parameters:
p The address the data is written to. Note that p must point to a memory area that is at least "size" bytes large.
size The number of bytes to be read.

Implements PhysicalInStream.

Definition at line 695 of file InStreams.h.

References File::read(), and stream.


Member Data Documentation

File* InFile::stream [private]

Object representing the file.

Definition at line 656 of file InStreams.h.

Referenced by exists(), getEof(), open(), readFromStream(), and ~InFile().


The documentation for this class was generated from the following file:
Generated on Thu Dec 7 01:38:32 2006 for DT2005.panorama by  doxygen 1.4.7