XabslFileInputSource Class Reference

File input class for Xabsl integration. More...

#include "xabsl_tools.h"

List of all members.

Public Member Functions
	XabslFileInputSource (const char *filename)
	Constructor.
	~XabslFileInputSource ()
	Destructor.
virtual bool	open ()
	Open file.
virtual void	close ()
	Close file.
virtual double	readValue ()
	Read a double value from the file.
virtual bool	readString (char *destination, int maxLength)
	Read a string from the file.

---

Detailed Description

File input class for Xabsl integration.

Author:

Tim Niemueller

Definition at line 47 of file xabsl_tools.h.

---

Constructor & Destructor Documentation

XabslFileInputSource::XabslFileInputSource

(

const char *

filename

)

Constructor.

Parameters:

filename

name of the file to read

Definition at line 74 of file xabsl_tools.cpp.

XabslFileInputSource::~XabslFileInputSource

(

)

Destructor.

Definition at line 82 of file xabsl_tools.cpp.

References close().

---

Member Function Documentation

void XabslFileInputSource::close ( )

virtual

Close file.

Definition at line 103 of file xabsl_tools.cpp.

Referenced by open(), and ~XabslFileInputSource().

bool XabslFileInputSource::open ( )

virtual

Open file.

Returns:

true if file has been opened successfully, false otherwise

Definition at line 93 of file xabsl_tools.cpp.

References close().

bool XabslFileInputSource::readString ( char *  buf, int  buf_length  )

virtual

Read a string from the file.

Parameters:

buf	buffer where the string is stored
buf_length	maximum length of the string to be read, warning, this method will write one more byte than buf_length. This is done to be compatible with broken Xabsl.

Returns:

true on success, false otherwise

Definition at line 133 of file xabsl_tools.cpp.

double XabslFileInputSource::readValue ( )

virtual

Read a double value from the file.

Returns:

value read from the file

Definition at line 114 of file xabsl_tools.cpp.

---

The documentation for this class was generated from the following files:

• src/plugins/xabsl/xabsl_tools.h
• src/plugins/xabsl/xabsl_tools.cpp