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 data sizes in the file. 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) :: pos, record_size
 
    this%indexed = .false.
    this%nrecords = 0
    call this%rewind()
    if (allocated(this%record_sizes)) deallocate (this%record_sizes)
 
    ! first pass: count
    do
      call this%read_record(success)
      if (.not. success) exit
      this%nrecords = this%nrecords + 1
    end do
    call this%rewind()
    allocate (this%record_sizes(this%nrecords))
    ! second pass: save
    do
      call this%read_record(success)
      inquire (this%inunit, pos=pos)
      record_size = pos - this%header%pos
      if (.not. success) exit
      this%record_sizes(this%nrecords) = this%header%size + record_size
    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 101 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
        call fseek_stream(this%inunit, -2 * i4b, 1, iostat)
      else if (iostat < 0) then
        this%endoffile = .true.
        if (allocated(this%headernext)) deallocate (this%headernext)
      end if
    end if

Here is the call graph for this function:

rewind()

subroutine binaryfilereadermodule::rewind

(

class(binaryfilereadertype), intent(inout)

this

)

Definition at line 119 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.