FswFile Class Reference

Functional interface to a generic file in FSW. More...

Inheritance diagram for FswFile:

[legend]List of all members.

Public Member Functions
def	__init__
	Constructor.
def	fileID
	retrieve file ID
def	binary
	retrieve file data
def	uploaded
	retrieve file upload status
def	setUploaded
	Set file upload status.
def	write
	write file to stream (file descriptor)

---

Detailed Description

Functional interface to a generic file in FSW.

Definition at line 114 of file fileTools.py.

---

Member Function Documentation

def __init__ (    self,   fid,   bin,   uploaded = False )

Constructor. Parameters: fid  FswFileID for this file bin  Raw binary representation of file uploaded  True if file has been uploaded Reimplemented in FswFileFromData, and FswFileFromDisk. Definition at line 116 of file fileTools.py.

def binary (    self  )

retrieve file data Returns: a raw binary string Definition at line 134 of file fileTools.py.

def fileID (    self  )

retrieve file ID Returns: a FswFileID object Definition at line 127 of file fileTools.py.

def setUploaded (    self,   bool )

Set file upload status. Parameters: bool  True if file is uploaded Definition at line 148 of file fileTools.py.

def uploaded (    self  )

retrieve file upload status Returns: True if uploaded Definition at line 141 of file fileTools.py.

def write (    self,   stream )

write file to stream (file descriptor) Parameters: stream  Any writable file descriptor Definition at line 155 of file fileTools.py.

---

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

• fileTools.py

---