ApparatusFramework::FileSystem Class Reference
[Device Services]

#include <DeviceServices/common/current/include/FileSystem.h>

Inheritance diagram for ApparatusFramework::FileSystem:
ApparatusFramework::WinFileSys

List of all members.

Public Member Functions

 FileSystem ()
virtual ~FileSystem ()
virtual void initialize ()
virtual void startup ()
virtual Fileopen (const char *fileName, const char *mode)=0
virtual Filecreate (const char *fileName, const char *mode, const int32 version)=0
virtual int32 remove (const char *fileName)=0

Detailed Description

Interface to a file system as used in the apparatus services framework. Concrete file systems should implement this interface. They can then be mounted in the file manager, which provides a common access point for file manipulations.

Definition at line 69 of file FileSystem.h.


Constructor & Destructor Documentation

ApparatusFramework::FileSystem::FileSystem (  )  [inline]

Construction, destruction Constructs a new file system.

Definition at line 75 of file FileSystem.h.

virtual ApparatusFramework::FileSystem::~FileSystem (  )  [inline, virtual]

Destructs a file system.

Definition at line 79 of file FileSystem.h.


Member Function Documentation

virtual File* ApparatusFramework::FileSystem::create ( const char *  fileName,
const char *  mode,
const int32  version 
) [pure virtual]

Creates a file by its name. The file name (without the mount directory) is passed on from the file manager (e.g. myfile.txt).

Parameters:
fileName The path and filename
mode Specifies read "r" or write "w" access, according to ANSI C conventions.
version The version of this file. Useful when the format of the stored information changes.
Returns:
The created file
Note:
If null is returned, the file already exist or could not be created.

Implemented in ApparatusFramework::WinFileSys.

virtual void ApparatusFramework::FileSystem::initialize (  )  [inline, virtual]

Factory startup pattern Initializes the FileSystem accordingly to the factory startup pattern.

Definition at line 84 of file FileSystem.h.

virtual File* ApparatusFramework::FileSystem::open ( const char *  fileName,
const char *  mode 
) [pure virtual]

File access methods Opens a file by its name. The file name (without the mount directory) is passed on from the file manager (e.g. myfile.txt).

Parameters:
fileName The path and filename
mode Specifies read "r" or write "w" access, according to ANSI C conventions.
Returns:
The requested file
Note:
If null is returned, the file does not exist or is already in use.

Implemented in ApparatusFramework::WinFileSys.

virtual int32 ApparatusFramework::FileSystem::remove ( const char *  fileName  )  [pure virtual]

Removes the specified file. The file name has to contain the path according to UNIX conventions (e.g. /eeprom/myfile.txt).

Parameters:
fileName The absolute path and filename (no relative paths)
Returns:
Status of the method. See FileSysReturnCodes.

Implemented in ApparatusFramework::WinFileSys.

virtual void ApparatusFramework::FileSystem::startup (  )  [inline, virtual]

Starts up the FileSystem accordingly to the factory startup pattern.

Definition at line 88 of file FileSystem.h.

© 2004-2010 bbv Software Services AG / Apparatus Services