flextest.flexread.read_header.BinaryFile Class Reference

HELPER FUNCTIONS ##########. More...

Inheritance diagram for flextest.flexread.read_header.BinaryFile:

Collaboration diagram for flextest.flexread.read_header.BinaryFile:

Public Member Functions
def	__init__
def	read
def	write
def	seek
def	tell
def	flush
def	close

Public Attributes
	mode
	file
	order

Static Public Attributes
dictionary	structtypes

Detailed Description

HELPER FUNCTIONS ##########.

BinaryFile: A class for accessing data to/from large binary files
   

The data is meant to be read/write sequentially from/to a binary file.
One can request to read a piece of data with a specific type and shape
from it.  Also, it supports the notion of Fortran and C ordered data,
so that the returned data is always well-behaved (C-contiguous and
aligned).

This class is seeking capable.

:Author:   Francesc Alted
:Contact:  faltet@pytables.org
:Created:  2010-03-18
:Acknowledgment: Funding for the development of this code is provided
     through the Norwegian Research Council VAUUAV project #184724, 2010

Definition at line 569 of file read_header.py.

Constructor & Destructor Documentation

def flextest.flexread.read_header.BinaryFile.__init__	(		self,
			filename,
			mode = "r",
			order = "fortran"
	)

Open the `filename` for write/read binary files.

The `mode` can be 'r', 'w' or 'a' for reading (default),
writing or appending.  The file will be created if it doesn't
exist when opened for writing or appending; it will be
truncated when opened for writing.  Add a '+' to the mode to
allow simultaneous reading and writing.

`order` specifies whether the file is is written in 'fortran'
or 'c' order.

Definition at line 600 of file read_header.py.

    def __init__(self, filename, mode="r", order="fortran"):
        """Open the `filename` for write/read binary files.

        The `mode` can be 'r', 'w' or 'a' for reading (default),
        writing or appending.  The file will be created if it doesn't
        exist when opened for writing or appending; it will be
        truncated when opened for writing.  Add a '+' to the mode to
        allow simultaneous reading and writing.

        `order` specifies whether the file is is written in 'fortran'
        or 'c' order.
        """
        self.mode = mode + "b"
        self.file = open(filename, mode=self.mode, buffering=1)
        """The file handler."""
        if order not in ['fortran', 'c']:
            raise ValueError, "order should be either 'fortran' or 'c'."
        self.order = order
        """The order for file ('c' or 'fortran')."""