F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Directory.hpp
Go to the documentation of this file.
1 #ifndef _Directory_hpp_
2 #define _Directory_hpp_
3 
4 #include <FpConfig.hpp>
6 
7 namespace Os {
8 
9  // This class encapsulates a very simple directory interface that has the most often-used features
10 
11  class Directory {
12  public:
13 
14  typedef enum {
22  } Status;
23 
24  Directory();
25  virtual ~Directory();
26  Status open(const char* dirName);
27  bool isOpen(void);
28  Status rewind();
29 
30  Status read(char * fileNameBuffer, U32 bufSize);
31  Status read(char * fileNameBuffer, U32 bufSize, I64& inode);
32  void close(void);
33 
35  const char* getLastErrorString(void);
36 
37  private:
38 
39  POINTER_CAST m_dir;
40  NATIVE_INT_TYPE m_lastError;
41 
42  };
43 
44 }
45 
46 #endif
Os
Definition: File.cpp:7
Os::Directory::NO_MORE_FILES
@ NO_MORE_FILES
Directory stream has no more files.
Definition: Directory.hpp:20
Os::Directory::close
void close(void)
close directory
Definition: Directory.cpp:120
Os::Directory::NOT_OPENED
@ NOT_OPENED
Directory hasn't been opened yet.
Definition: Directory.hpp:18
Os::Directory::NOT_DIR
@ NOT_DIR
Path is not a directory.
Definition: Directory.hpp:19
Os::Directory::Directory
Directory()
Constructor.
Definition: Directory.cpp:17
Os::Directory
Definition: Directory.hpp:11
Os::Directory::OP_OK
@ OP_OK
Operation was successful.
Definition: Directory.hpp:15
Os::Directory::isOpen
bool isOpen(void)
check if file descriptor is open or not.
Definition: Directory.cpp:116
Os::Directory::getLastError
NATIVE_INT_TYPE getLastError(void)
read back last error code (typically errno)
Definition: Directory.cpp:128
Os::Directory::rewind
Status rewind()
rewind directory stream to the beginning
Definition: Directory.cpp:53
Os::Directory::getLastErrorString
const char * getLastErrorString(void)
get a string of the last error (typically from strerror)
Definition: Directory.cpp:132
Os::Directory::~Directory
virtual ~Directory()
Destructor. Will close directory if still open.
Definition: Directory.cpp:20
Os::Directory::open
Status open(const char *dirName)
open directory. Directory must already exist
Definition: Directory.cpp:24
Os::Directory::OTHER_ERROR
@ OTHER_ERROR
A catch-all for other errors. Have to look in implementation-specific code.
Definition: Directory.hpp:21
Os::Directory::read
Status read(char *fileNameBuffer, U32 bufSize)
get next filename from directory
Definition: Directory.cpp:69
FpConfig.hpp
ISF configuration file.
Os::Directory::DOESNT_EXIST
@ DOESNT_EXIST
Directory doesn't exist.
Definition: Directory.hpp:16
Os::Directory::Status
Status
Definition: Directory.hpp:14
Os::Directory::NO_PERMISSION
@ NO_PERMISSION
No permission to read directory.
Definition: Directory.hpp:17
BasicTypes.hpp
Declares ISF basic types.
NATIVE_INT_TYPE
int NATIVE_INT_TYPE
native integer type declaration
Definition: BasicTypes.hpp:29