binaryfilereadermodule Module Reference

Data Types
type	binaryfileheadertype
type	binaryfilereadertype
interface	read_header_if
interface	read_record_if

Functions/Subroutines
character(len=:) function, allocatable	get_str (this)
	Get a string representation of the header. More...
subroutine	build_index (this)
	Build an index of record positions in the file. More...
subroutine	seek_to_index (this, index)
	Position the file at the start of an indexed record. More...
subroutine	peek_record (this)
	Peek to see if another record is available. More...
subroutine	rewind (this)
	Rewind the file to the beginning. More...

Function/Subroutine Documentation

build_index()

subroutine binaryfilereadermodule::build_index

(

class(binaryfilereadertype), intent(inout)

this

)

Definition at line 68 of file BinaryFileReader.f90.

    class(BinaryFileReaderType), intent(inout) :: this
    ! local
    logical(LGP) :: success
    integer(I4B) :: i
 
    this%indexed = .false.
    this%nrecords = 0
    call this%rewind()
    if (allocated(this%record_positions)) deallocate (this%record_positions)
 
    ! first pass: count
    do
      call this%read_record(success)
      if (.not. success) exit
      this%nrecords = this%nrecords + 1
    end do
 
    ! second pass: save positions (read first so header%pos is set)
    call this%rewind()
    allocate (this%record_positions(this%nrecords))
    i = 0
    do
      call this%read_record(success)
      if (.not. success) exit
      i = i + 1
      this%record_positions(i) = this%header%pos
    end do
    call this%rewind()
 
    this%indexed = .true.

get_str()

character(len=:) function, allocatable binaryfilereadermodule::get_str

(

class(binaryfileheadertype), intent(in)

this

)

Definition at line 53 of file BinaryFileReader.f90.

    class(BinaryFileHeaderType), intent(in) :: this
    character(len=:), allocatable :: str
 
    write (str, '(*(G0))') &
      'Binary file header (pos: ', this%pos, &
      ', kper: ', this%kper, &
      ', kstp: ', this%kstp, &
      ', pertim: ', this%pertim, &
      ', totim: ', this%totim, &
      ')'
    str = trim(str)

peek_record()

subroutine binaryfilereadermodule::peek_record

(

class(binaryfilereadertype), intent(inout)

this

)

Definition at line 124 of file BinaryFileReader.f90.

    class(BinaryFileReaderType), intent(inout) :: this
    ! local
    integer(I4B) :: iostat
 
    if (.not. this%endoffile) then
      inquire (this%inunit, pos=this%headernext%pos)
      read (this%inunit, iostat=iostat) this%headernext%kstp, this%headernext%kper
      if (iostat == 0) then
        read (this%inunit, pos=this%headernext%pos, iostat=iostat)
      else if (iostat < 0) then
        this%endoffile = .true.
        if (allocated(this%headernext)) deallocate (this%headernext)
      end if
    end if

rewind()

subroutine binaryfilereadermodule::rewind

(

class(binaryfilereadertype), intent(inout)

this

)

Definition at line 142 of file BinaryFileReader.f90.

    class(BinaryFileReaderType), intent(inout) :: this
 
    rewind(this%inunit)
    if (allocated(this%header)) deallocate (this%header)
    if (allocated(this%headernext)) deallocate (this%headernext)
    allocate (binaryfileheadertype :: this%header)
    allocate (binaryfileheadertype :: this%headernext)
    this%header%pos = 1
    this%headernext%pos = 1
    this%endoffile = .false.

seek_to_index()

subroutine binaryfilereadermodule::seek_to_index	(	class(binaryfilereadertype), intent(inout)	this,
		integer(i4b), intent(in)	index
	)

Definition at line 102 of file BinaryFileReader.f90.

    class(BinaryFileReaderType), intent(inout) :: this
    integer(I4B), intent(in) :: index
    ! local
    integer(I4B) :: iostat
 
    if (.not. this%indexed) &
      call pstop(1, 'Cannot seek to index in unindexed file')
    if (index < 1 .or. index > this%nrecords) then
      this%endoffile = .true.
      return
    end if
 
    read (this%inunit, pos=this%record_positions(index), iostat=iostat)
    if (iostat /= 0) call pstop(1, 'Error seeking to index position')
    ! peek_record deallocates headernext at end of file
    if (.not. allocated(this%headernext)) &
      allocate (this%headernext, mold=this%header)
    this%endoffile = .false.

Here is the call graph for this function: