NXTFile Struct Reference

Abstraction for NXT iFile interface. More...

#include <comm.h>

List of all members.

Public Member Functions

 NXTFile ()
 The NXTFile constructor.
 NXTFile (nFANTOM100::iFile *f)
 This constructs an NXTFile from the Fantom file type. Only in the Windows version.
bool isValid ()
int open (int mode, int size=100)
int remove ()
int read (char *buff, int size)
int write (char *buff, int size)
int close ()

Public Attributes

char * name
 The name of the file.
int size
 The size in bytes of the file.
int asize
 The size in bytes of available space in the file.
int mode
 The mode the file is currently in.
bool isOpen
 Whether the file is open or not.
bool isWriteable
 Whether the file is writeable or not.
nFANTOM100::iFile * file
 The Fantom file pointer. Only in the Windows version.


Detailed Description

Abstraction for NXT iFile interface.

Definition at line 45 of file comm.h.


Constructor & Destructor Documentation

NXTFile::NXTFile (  )  [inline]

The NXTFile constructor.

Definition at line 48 of file comm.h.

References asize, isOpen, isWriteable, and size.

NXTFile::NXTFile ( nFANTOM100::iFile *  f  )  [inline]

This constructs an NXTFile from the Fantom file type. Only in the Windows version.

Definition at line 57 of file comm.h.

References asize, file, isOpen, isWriteable, name, and size.


Member Function Documentation

bool NXTFile::isValid (  ) 

int NXTFile::open ( int  mode,
int  size = 100 
)

int NXTFile::remove (  ) 

int NXTFile::read ( char *  buff,
int  size 
)

int NXTFile::write ( char *  buff,
int  size 
)

int NXTFile::close (  ) 


Member Data Documentation

char* NXTFile::name

The name of the file.

Definition at line 78 of file comm.h.

Referenced by NXTFile().

int NXTFile::size

The size in bytes of the file.

Definition at line 80 of file comm.h.

Referenced by NXTFile().

int NXTFile::asize

The size in bytes of available space in the file.

Definition at line 82 of file comm.h.

Referenced by NXTFile().

int NXTFile::mode

The mode the file is currently in.

Definition at line 84 of file comm.h.

bool NXTFile::isOpen

Whether the file is open or not.

Definition at line 87 of file comm.h.

Referenced by NXTFile().

bool NXTFile::isWriteable

Whether the file is writeable or not.

Definition at line 89 of file comm.h.

Referenced by NXTFile().

nFANTOM100::iFile* NXTFile::file

The Fantom file pointer. Only in the Windows version.

Definition at line 93 of file comm.h.

Referenced by NXTFile().


The documentation for this struct was generated from the following file:
SourceForge.net Logo