mglib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

fileio/

mgfffile__define.pro

includes main-level program

Represents a file.

Class description for mgfffile

Inheritance

Properties

Properties in mgfffile

atime get
block_special get
character_special get
ctime get
dangling_symlink get
directory get
execute get
exists get
filename get
mtime get
named_pipe get
read get
regular get
setgid get
setuid get
size get
socket get
sticky_bit get
symlink get
write get

Routines

Methods inherited from idl_object

Routines from mgfffile__define.pro

result = mgfffile::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)

Read portions of a file using bracket notation in IDL 8.0.

mgfffile::getProperty, filename=filename, exists=exists, read=read, write=write, execute=execute, regular=regular, directory=directory, block_special=block_special, character_special=character_special, named_pipe=named_pipe, setgid=setgid, setuid=setuid, socket=socket, sticky_bit=sticky_bit, symlink=symlink, dangling_symlink=dangling_symlink, atime=atime, ctime=ctime, mtime=mtime, size=size

Get properties.

result = mgfffile::readu( [type=long], dimension=lonarr [, offset=long])

Read binary data from the file.

result = mgfffile::readf( [/single])

Read the file into a string array, or a single string if SINGLE is set.

result = mgfffile::init(filename)

Create a file object.

mgfffile__define

Define instance variables.

Routine details

top mgfffile::_overloadBracketsRightSide

result = mgfffile::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)

Read portions of a file using bracket notation in IDL 8.0.

Return value

Parameters

isRange
ss1
ss2
ss3
ss4
ss5
ss6
ss7
ss8

top mgfffile::getProperty

mgfffile::getProperty, filename=filename, exists=exists, read=read, write=write, execute=execute, regular=regular, directory=directory, block_special=block_special, character_special=character_special, named_pipe=named_pipe, setgid=setgid, setuid=setuid, socket=socket, sticky_bit=sticky_bit, symlink=symlink, dangling_symlink=dangling_symlink, atime=atime, ctime=ctime, mtime=mtime, size=size

Get properties.

Keywords

filename
exists
read
write
execute
regular
directory
block_special
character_special
named_pipe
setgid
setuid
socket
sticky_bit
atime
ctime
mtime
size

top mgfffile::readu

result = mgfffile::readu( [type=long], dimension=lonarr [, offset=long])

Read binary data from the file.

Return value

array

Keywords

type in optional type=long default=1L

SIZE type code for data to read

dimension in required type=lonarr

dimensions of the array to read, defaults to full size of file (after any OFFSET is skipped)

offset in optional type=long

number of bytes to skip before reading

top mgfffile::readf

result = mgfffile::readf( [/single])

Read the file into a string array, or a single string if SINGLE is set.

Return value

string, strarr

Keywords

single in optional type=boolean

top mgfffile::init

result = mgfffile::init(filename)

Create a file object.

Return value

1 if successful, 0 if failure

Parameters

filename in required type=string

filename of file

top mgfffile__define

mgfffile__define

Define instance variables.

File attributes

Modification date: Wed May 14 15:07:14 2014
Lines: 95
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.