LICOS.lib.cmdTlmDb.FILE.FILE

FILE Class Reference

FILE telecommand package class. More...

Inheritance diagram for FILE:

Inheritance graph
[legend]
Collaboration diagram for FILE:

Collaboration graph
[legend]
List of all members.

Public Member Functions

def __init__
 FILE constructor.
def downloadFile
 Download a file from the LAT.
def downloadFileToSSR
 Download a file from the LAT.
def dumpDirectory
 Download a directory listing from the LAT.
def createDirectory
 create a directory on a LAT file system
def deleteDirectory
 Delete a directory on a LAT filesystem.
def uploadFileFromDisk
 Upload a disk resident file with an FMX header.
def uploadFileFromData
 Upload a memory resident file with an FMX header (Typically received from MOOT).
def cancelUpload
 cancel any in process uploads
def uploadFile
 Upload a memory resident fsw file object.
def copyFile
 Copy a file on any LAT unit.
def deleteFile
 Delete a file on a LAT filesystem.
def __LFSUNIT
def __uploadChunk
def checkLastCommandStatus
def setPrimaryBoot

Private Attributes

 __primaryBoot

Detailed Description

FILE telecommand package class.

Provides access to FILE telecommands.

Definition at line 68 of file FILE.py.

Member Function Documentation

def __init__ (    self,
  db
) 
 

FILE constructor.

Parameters:
db Wrapper database object for the generated module containing command and telemetry database classes.

Reimplemented from CmdPkg.

Definition at line 70 of file FILE.py.

def __LFSUNIT (    self,
  realUnit,
  tranID = 0
) 
 

Definition at line 574 of file FILE.py.

def __uploadChunk (    self,
  uplChunk,
  offset,
  nDataBytes
) 
 

Definition at line 578 of file FILE.py.

def cancelUpload (    self,
  unit
) 
 

cancel any in process uploads

Parameters:
app A testAppBase object (your user application...)
fswFile FswFile object
unit LAT unit id to upload to
Returns:
status

Definition at line 361 of file FILE.py.

def checkLastCommandStatus (    self,
  timeout = STANDARD_TIMEOUT
) 
 

Definition at line 592 of file FILE.py.

def copyFile (    self,
  unit,
  source,
  dest,
  destUnit = None
) 
 

Copy a file on any LAT unit.

Parameters:
app A testAppBase object (your user application...)
unit LAT unit id to upload to
source An FswFileID object corresponding to the source file
dest An FswFileID object corresponding to the destination file
destUnit Unit to copy to (Default = None ==> same unit)
Returns:
status True if success, False if failure

Definition at line 521 of file FILE.py.

def createDirectory (    self,
  unit,
  directoryID
) 
 

create a directory on a LAT file system

Parameters:
unit LAT unit id
directoryID An FswFileID object with the correct directory set.
Returns:
status True if it worked, False if not.

Definition at line 277 of file FILE.py.

def deleteDirectory (    self,
  unit,
  directoryID,
  force = False
) 
 

Delete a directory on a LAT filesystem.

Parameters:
unit LAT unit id to upload to
directoryID An FswFileID object with the correct directory set.
Returns:
status True if success, False if failure

Definition at line 295 of file FILE.py.

def deleteFile (    self,
  unit,
  fileID
) 
 

Delete a file on a LAT filesystem.

Parameters:
app A testAppBase object (your user application...)
unit LAT unit id to upload to
fileID An FswFileID object
Returns:
status True if success, False if failure

Definition at line 560 of file FILE.py.

def downloadFile (    self,
  unit,
  fileID
) 
 

Download a file from the LAT.

Parameters:
unit LAT unit id to upload to
fileID An FswFileID object
Returns:
An FswFile object containing the data uploaded

Definition at line 81 of file FILE.py.

def downloadFileToSSR (    self,
  unit,
  fileID
) 
 

Download a file from the LAT.

Parameters:
app A testAppBase object (your user application...)
unit LAT unit id to upload to
fileID An FswFileID object
Returns:
status

Definition at line 174 of file FILE.py.

def dumpDirectory (    self,
  unit,
  directoryID,
  root = False
) 
 

Download a directory listing from the LAT.

Parameters:
unit LAT unit id to upload to
fileID An FswFileID object with the correct directory set.
Returns:
An FswFile object containing the data uploaded

Definition at line 188 of file FILE.py.

def setPrimaryBoot (    self,
  bool
) 
 

Definition at line 609 of file FILE.py.

def uploadFile (    self,
  fswFile,
  unit
) 
 

Upload a memory resident fsw file object.

Parameters:
app A testAppBase object (your user application...)
fswFile FswFile object
unit LAT unit id to upload to
Returns:
status

Definition at line 373 of file FILE.py.

def uploadFileFromData (    self,
  fileData,
  unit,
  fileID
) 
 

Upload a memory resident file with an FMX header (Typically received from MOOT).

Parameters:
app A testAppBase object (your user application...)
fileData Binary representation of an FMX file
unit LAT unit id to upload to
fileID An FswFileID object
Returns:
An FswFile object containing the data uploaded

Definition at line 343 of file FILE.py.

def uploadFileFromDisk (    self,
  fileName,
  unit,
  fileID
) 
 

Upload a disk resident file with an FMX header.

Parameters:
app A testAppBase object (your user application...)
fileName Fully qualified file name
unit LAT unit id to upload to
fileID An FswFileID object
Returns:
An FswFile object containing the data uploaded

Definition at line 325 of file FILE.py.

Member Data Documentation

__primaryBoot [private]
 

Definition at line 610 of file FILE.py.

The documentation for this class was generated from the following file:
Generated on Thu Apr 27 20:53:03 2006 for LICOS L02-01-00 by doxygen 1.4.6-NO