BaseFileReader

BaseFileReader

Abstract class that should be extended

Constructor

new BaseFileReader(header_class, options) → {BaseFileReader}

Constructs a file reader for specific file types

Source:
Parameters:
Name Type Description
header_class BlueFileHeader | MatFileHeader
options object
Returns:
Type:
BaseFileReader

Methods

(private) _read(theFile, onload, justHeader)

Internal method that will read a file or stop at the header

Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile

onload function

callback when the header has been read

justHeader boolean

Whether or not to only read the header

read(theFile, onload)

Read a local Bluefile or Matfile on disk.

Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile

onload function

callback when the file has been read

read_http(href, onload)

Read a Bluefile or Matfile from a URL

Source:
Parameters:
Name Type Description
href string

the URL for the Bluefile or Matfile

onload function

callback when the header has been read

readheader(theFile, onload)

Read only the header from a local {Blue,Mat}file.

Source:
Parameters:
Name Type Description
theFile File

a File object for the Bluefile or Matfile

onload function

callback when the header has been read