FileUtil Class Reference

class used to make it easy to read and write files. More...

#include <OSFileUtil.h>

Public Member Functions
	FileUtil ()
	the class constructor More...
	~FileUtil ()
	the class destructor More...
std::string	getFileAsString (const char *fname)
	read a file and return contents as a string. More...
char *	getFileAsChar (const char *fname)
	read a file and return contents as a char pointer. More...
bool	writeFileFromString (char *fname, std::string thestring)
	write a file from an input string. More...
bool	writeFileFromString (std::string fname, std::string thestring)
	write a file from an input string. More...
bool	writeFileFromChar (char *fname, char *ch)
	write a file from an input char pointer. More...

Detailed Description

class used to make it easy to read and write files.

Author

Robert Fourer, Jun Ma, Kipp Martin

Version

1.0, 03/14/2004

Since

OS 1.0

Remarks

The FileUtil class contains methods for reading and writing files from strings used by many classes in the Optimization Services (OS) framework.

Definition at line 37 of file OSFileUtil.h.

Constructor & Destructor Documentation

FileUtil::FileUtil

(

)

the class constructor

Definition at line 26 of file OSFileUtil.cpp.

FileUtil::~FileUtil

(

)

the class destructor

Definition at line 31 of file OSFileUtil.cpp.

Member Function Documentation

std::string FileUtil::getFileAsString

(

const char *

fname

)

read a file and return contents as a string.

Parameters

fname

holds the name of the file.

Returns

the file contents as a string.

Definition at line 35 of file OSFileUtil.cpp.

char * FileUtil::getFileAsChar

(

const char *

fname

)

read a file and return contents as a char pointer.

Parameters

fname

holds the name of the file.

Returns

the file contents as a char pointer.

Definition at line 70 of file OSFileUtil.cpp.

bool FileUtil::writeFileFromString	(	char *	fname,
		std::string	thestring
	)

write a file from an input string.

Parameters

fname	holds the name of the file to be written.
thestring	holds the string to be written to the file.

Returns

true if file successfuly written.

Definition at line 116 of file OSFileUtil.cpp.

bool FileUtil::writeFileFromString	(	std::string	fname,
		std::string	thestring
	)

write a file from an input string.

Parameters

fname	holds the name of the file to be written.
thestring	holds the string to be written to the file.

Returns

true if file successfuly written.

Definition at line 148 of file OSFileUtil.cpp.

bool FileUtil::writeFileFromChar	(	char *	fname,
		char *	ch
	)

write a file from an input char pointer.

Parameters

fname	holds the name of the file to be written.
ch	holds a pointer to a char array to be written to the file.

Returns

true if file successfully written.

Definition at line 180 of file OSFileUtil.cpp.

---

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

• /tmp/OS-2.10.2/OS/src/OSUtils/OSFileUtil.h
• /tmp/OS-2.10.2/OS/src/OSUtils/OSFileUtil.cpp