tabletermmodule Module Reference

Data Types
type	tabletermtype

Functions/Subroutines
subroutine	initialize (this, tag, width, alignment)
integer(i4b) function	get_width (this)
integer(i4b) function	get_alignment (this)
integer(i4b) function	get_header_lines (this)
subroutine	allocate_scalars (this)
subroutine	da (this)
subroutine	set_header (this, nlines)
subroutine	get_header (this, iline, cval)

Function/Subroutine Documentation

allocate_scalars()

subroutine tabletermmodule::allocate_scalars

(

class(tabletermtype)

this

)

Definition at line 204 of file TableTerm.f90.

! ******************************************************************************
! allocate_scalars -- allocate table term scalars
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
! ------------------------------------------------------------------------------
    !
    ! -- allocate scalars
    allocate (this%tag)
    allocate (this%alignment)
    allocate (this%width)
    allocate (this%nheader_lines)
    !
    ! -- initialize scalars
    this%nheader_lines = 0
    !
    ! -- return
    return

da()

subroutine tabletermmodule::da

(

class(tabletermtype)

this

)

Definition at line 229 of file TableTerm.f90.

! ******************************************************************************
! da -- deallocate table terms
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    ! -- local
    !integer(I4B) :: n
! ------------------------------------------------------------------------------
    !
    ! -- deallocate scalars
    deallocate (this%tag)
    deallocate (this%alignment)
    deallocate (this%width)
    deallocate (this%nheader_lines)
    deallocate (this%header_lines)
    !
    ! -- return

get_alignment()

integer(i4b) function tabletermmodule::get_alignment

(

class(tabletermtype)

this

)

Definition at line 164 of file TableTerm.f90.

! ******************************************************************************
! get_width -- get column width
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- return variable
    integer(I4B) :: get_alignment
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    ! -- local
! ------------------------------------------------------------------------------
    get_alignment = this%alignment
    !
    ! -- return
    return

get_header()

subroutine tabletermmodule::get_header	(	class(tabletermtype)	this,
		integer(i4b), intent(in)	iline,
		character(len=*), intent(inout)	cval
	)

Definition at line 301 of file TableTerm.f90.

! ******************************************************************************
! get_header -- get header entry for table term iline
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    integer(I4B), intent(in) :: iline
    character(len=*), intent(inout) :: cval
    ! -- return variable
    ! -- local
! ------------------------------------------------------------------------------
    !
    ! -- set return value
    cval = this%header_lines(iline) (1:this%width)
    !
    ! -- return

get_header_lines()

integer(i4b) function tabletermmodule::get_header_lines

(

class(tabletermtype)

this

)

Definition at line 184 of file TableTerm.f90.

! ******************************************************************************
! get_header_lines -- get the number of lines in initial_lines
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- return variable
    integer(I4B) :: get_header_lines
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    ! -- local
! ------------------------------------------------------------------------------
    get_header_lines = this%nheader_lines
    !
    ! -- return
    return

get_width()

integer(i4b) function tabletermmodule::get_width

(

class(tabletermtype)

this

)

Definition at line 144 of file TableTerm.f90.

! ******************************************************************************
! get_width -- get column width
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- return variable
    integer(I4B) :: get_width
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    ! -- local
! ------------------------------------------------------------------------------
    get_width = this%width
    !
    ! -- return
    return

initialize()

subroutine tabletermmodule::initialize	(	class(tabletermtype)	this,
		character(len=*), intent(in)	tag,
		integer(i4b), intent(in)	width,
		integer(i4b), intent(in), optional	alignment
	)

Definition at line 41 of file TableTerm.f90.

! ******************************************************************************
! initialize -- initialize the table term
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    character(len=*), intent(in) :: tag
    integer(I4B), intent(in) :: width
    integer(I4B), intent(in), optional :: alignment
    ! -- local
    character(len=LINELENGTH) :: string
    character(len=LINELENGTH) :: tstring
    character(len=LINELENGTH), allocatable, dimension(:) :: words
    integer(I4B) :: nwords
    integer(I4B) :: ilen
    integer(I4B) :: i
    integer(I4B) :: j
 
! ------------------------------------------------------------------------------
    !
    ! -- allocate scalars
    call this%allocate_scalars()
 
    ! -- process dummy variables
    this%tag = tag
 
    if (present(alignment)) then
      this%alignment = alignment
    else
      this%alignment = tabcenter
    end if
 
    this%width = width
    !
    ! -- parse tag into words
    call parseline(tag, nwords, words, 0)
    !
    ! -- abbreviate any words that exceed the specified width
    !    and trim trailing characters
    do i = 1, nwords
      ilen = len(trim(words(i)))
      if (ilen > width) then
        words(i) (width:width) = '.'
        do j = width + 1, ilen
          words(i) (j:j) = ' '
        end do
      end if
    end do
    !
    ! -- combine words that fit into width
    i = 0
    do
      i = i + 1
      if (i > nwords) then
        exit
      end if
      string = trim(adjustl(words(i)))
      tstring = string
      do j = i + 1, nwords
        if (len(trim(adjustl(string))) > 0) then
          tstring = trim(adjustl(tstring))//' '//trim(adjustl(words(j)))
        else
          tstring = trim(adjustl(words(j)))
        end if
        ilen = len(trim(adjustl(tstring)))
        if (ilen == 0) then
          continue
        else if (ilen <= width) then
          words(j) = ' '
          string = tstring
        else
          exit
        end if
      end do
      words(i) = string
    end do
    !
    ! -- calculate the number of header lines
    do i = 1, nwords
      ilen = len(trim(adjustl(words(i))))
      if (ilen > 0) then
        this%nheader_lines = this%nheader_lines + 1
      end if
    end do
    !
    ! allocate initial_lines and fill with words
    allocate (this%initial_lines(this%nheader_lines))
    do i = 1, this%nheader_lines
      this%initial_lines(i) = words(i) (1:width)
    end do
    !
    ! -- deallocate words
    deallocate (words)
    !
    ! -- return
    return
 

Here is the call graph for this function:

set_header()

subroutine tabletermmodule::set_header	(	class(tabletermtype)	this,
		integer(i4b), intent(in)	nlines
	)

Definition at line 253 of file TableTerm.f90.

! ******************************************************************************
! set_header -- set final header lines for table term
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    ! -- dummy
    class(TableTermType) :: this
    integer(I4B), intent(in) :: nlines
    ! -- local
    character(len=this%width) :: string
    integer(I4B) :: idiff
    integer(I4B) :: i0
    integer(I4B) :: i
    integer(I4B) :: j
! ------------------------------------------------------------------------------
    !
    ! -- initialize variables
    string = ' '
    !
    ! allocate header_lines
    allocate (this%header_lines(nlines))
    !
    ! -- initialize header lines
    do i = 1, nlines
      this%header_lines(i) = string
    end do
    !
    ! -- fill header_lines with initial_lines from
    !    bottom to top
    idiff = nlines - this%nheader_lines
    i0 = 1 - idiff
    do i = this%nheader_lines, 1, -1
      j = i + idiff
      this%header_lines(j) = this%initial_lines(i)
    end do
    !
    ! -- deallocate temporary header lines
    deallocate (this%initial_lines)
    !
    ! -- reinitialize nheader_lines
    this%nheader_lines = nlines
    !
    ! -- return