ARLib::Utility::ARFile Class Reference

Class for manipulating and retrieving information about an os file. More...

#include <arfile.h>

List of all members.

Public Member Functions
	ARFile (const char *path)
	Constructor for ARFilename object.
void	SetFile (const char *path)
	Sets the file for the current ARFile object.
ARString	GetFilename ()
	Returns the name of the file excluding the path.
ARString	GetPath ()
	Returns the path excluding the filename.
ARString	GetFullPath ()
	Returns the original path/.
ARString	GetExtension ()
	Returns the extension for the filename.
ARString	GetName ()
	Returns the name of the file excluding the path and extension.
bool	Exists ()
	Determines whether the file exists.

---

Detailed Description

Class for manipulating and retrieving information about an os file.

---

Constructor & Destructor Documentation

ARLib::Utility::ARFile::ARFile (  const char *  path  )

Constructor for ARFilename object. Parameters: path  Pointer to the filename string (including path)

---

Member Function Documentation

bool ARLib::Utility::ARFile::Exists (   )

Determines whether the file exists. Returns: True if the file exists otherwise False

ARString ARLib::Utility::ARFile::GetExtension (   )

Returns the extension for the filename. For example, 'txt' would be returned if the path was '/samples/data/test001.txt'. Returns: A std::string object containing the extension.

ARString ARLib::Utility::ARFile::GetFilename (   )

Returns the name of the file excluding the path. For example, 'test001.txt' would be returned if the path was '/samples/data/test001.txt'. Returns: A std::string object containing the filename.

ARString ARLib::Utility::ARFile::GetFullPath (   )  [inline]

Returns the original path/. For example, '/samples/data/test001.txt' would be returned if the path was '/samples/data/test001.txt'. Returns: A std::string object containing the full path.

ARString ARLib::Utility::ARFile::GetName (   )

Returns the name of the file excluding the path and extension. For example, 'test001' would be returned if the path was '/samples/data/test001.txt'. Returns: A std::string object containing the name.

ARString ARLib::Utility::ARFile::GetPath (   )

Returns the path excluding the filename. For example, '/samples/data/' would be returned if the path was '/samples/data/test001.txt'. Returns: A std::string object containing the path.

void ARLib::Utility::ARFile::SetFile (  const char *  path  )

Sets the file for the current ARFile object. Parameters: path  Pointer to the filename string (including path)

---

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

• arfile.h

---