plot_bar Derived Type

type, public, extends(plot_2d) :: plot_bar

Defines a 2D plot tailored towards bar plotting.


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: clear_all => plt_clear_all

  • private subroutine plt_clear_all(this)

    Removes all plot_data objects from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: clear_all_labels => plt_clear_labels

  • private subroutine plt_clear_labels(this)

    Clears all plot_label objects from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: clear_arrows => plt_clear_arrows

  • private subroutine plt_clear_arrows(this)

    Clears all plot_arrow objects from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: draw => plt_draw

  • private subroutine plt_draw(this, persist, err)

    Launches GNUPLOT and draws the plot per the current state of the command list.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.
    logical, intent(in), optional :: persist

    An optional parameter that can be used to keep GNUPLOT open.
    Set to true to force GNUPLOT to remain open; else, set to false to allow GNUPLOT to close after drawing. The default is true.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: free_resources => plt_clean_up

  • private subroutine plt_clean_up(this)

    Cleans up resources held by the plot object. Inheriting classes are expected to call this routine to free internally held resources.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: get => plt_get

  • private function plt_get(this, i) result(x)

    Gets a pointer to the requested plot_data object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_data object.

    Return Value class(plot_data), pointer

    A pointer to the requested plot_data object.

procedure, public :: get_arrow => plt_get_arrow

  • private function plt_get_arrow(this, i) result(rst)

    Gets a pointer to the requested plot_arrow object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_arrow to retrieve.

    Return Value class(plot_arrow), pointer

    The plot_arrow object to retrieve.

procedure, public :: get_arrow_count => plt_get_arrow_count

  • private pure function plt_get_arrow_count(this) result(rst)

    Gets the number of plot_arrow objects held by the plot object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value integer(kind=int32)

    The plot_arrow objects count.

procedure, public :: get_axis_equal => plt_get_axis_equal

  • private pure function plt_get_axis_equal(this) result(rst)

    Gets a flag determining if the axes should be equally scaled.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if the axes should be scaled equally; else, false.

procedure, public :: get_bar_width => pb_get_bar_width

  • private pure function pb_get_bar_width(this) result(x)

    Gets the bar width scaling factor.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_bar), intent(in) :: this

    The plot_bar object.

    Return Value real(kind=real32)

    The scaling factor.

procedure, public :: get_colormap => plt_get_colormap

  • private function plt_get_colormap(this) result(x)

    Gets a pointer to the colormap object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value class(colormap), pointer

    A pointer to the colormap object. If no colormap is defined, a null pointer is returned.

procedure, public :: get_command_string => pb_get_cmd

  • private function pb_get_cmd(this) result(x)

    Gets the GNUPLOT commands required to draw the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_bar), intent(in) :: this

    The plot_bar object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_count => plt_get_count

  • private pure function plt_get_count(this) result(x)

    Gets the number of stored plot_data objects.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value integer(kind=int32)

    The number of plot_data objects.

procedure, public :: get_draw_border => plt_get_draw_border

  • private pure function plt_get_draw_border(this) result(x)

    Gets a value determining if the border should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if the border should be drawn; else, false.

procedure, public :: get_font_name => plt_get_font

  • private function plt_get_font(this) result(x)

    Gets the name of the font used for plot text.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value character(len=:), allocatable

    The font name.

procedure, public :: get_font_size => plt_get_font_size

  • private function plt_get_font_size(this) result(x)

    Gets the size of the font used by the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value integer(kind=int32)

    The size of the font, in points.

procedure, public :: get_label => plt_get_label

  • private function plt_get_label(this, i) result(x)

    Gets the requested plot_label from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_label object to retrieve.

    Return Value class(plot_label), pointer

    A pointer to the requested plot_label object.

procedure, public :: get_label_count => plt_get_label_count

  • private pure function plt_get_label_count(this) result(x)

    Gets the number of plot_label objects belonging to the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value integer(kind=int32)

    The number of plot_label objects.

procedure, public :: get_legend => plt_get_legend

  • private function plt_get_legend(this) result(x)

    Gets the plot's legend object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value type(legend), pointer

    A pointer to the legend object.

procedure, public :: get_show_colorbar => plt_get_show_colorbar

  • private pure function plt_get_show_colorbar(this) result(x)

    Gets a value determining if the colorbar should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if the colorbar should be drawn; else, false.

procedure, public :: get_show_gridlines => plt_get_show_grid

  • private pure function plt_get_show_grid(this) result(x)

    Gets a flag determining if the grid lines should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if the grid lines should be shown; else, false.

procedure, public :: get_square_axes => p2d_get_square_axes

  • private pure function p2d_get_square_axes(this) result(rst)

    Gets a logical flag determining if the axes size should be squared off.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(in) :: this

    The plot_2d object.

    Return Value logical

    Returns true if the axes are to be sized to a square; else, false.

procedure, public :: get_terminal => plt_get_term

  • private function plt_get_term(this) result(x)

    Gets the GNUPLOT terminal object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value class(terminal), pointer

    A pointer to the GNUPLOT terminal object.

procedure, public :: get_tics_inward => plt_get_tics_in

  • private pure function plt_get_tics_in(this) result(x)

    Gets a value determining if the axis tic marks should point inwards.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if the tic marks should point inwards; else, false if the tic marks should point outwards.

procedure, public :: get_title => plt_get_title

  • private function plt_get_title(this) result(txt)

    Gets the plot's title.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value character(len=:), allocatable

    The title.

procedure, public :: get_use_y2_axis => p2d_get_use_y2

  • private pure function p2d_get_use_y2(this) result(x)

    Gets a flag determining if the secondary y-axis should be displayed.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(in) :: this

    The plot_2d object.

    Return Value logical

    Returns true if the axis should be displayed; else, false.

procedure, public :: get_x_axis => p2d_get_x_axis

  • private function p2d_get_x_axis(this) result(ptr)

    Gets the x-axis object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(in) :: this

    The plot_2d object.

    Return Value class(plot_axis), pointer

    A pointer to the x-axis object.

procedure, public :: get_y2_axis => p2d_get_y2_axis

  • private function p2d_get_y2_axis(this) result(ptr)

    Gets the secondary y-axis object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(in) :: this

    The plot_2d object.

    Return Value class(plot_axis), pointer

    A pointer to the secondary y-axis object.

procedure, public :: get_y_axis => p2d_get_y_axis

  • private function p2d_get_y_axis(this) result(ptr)

    Gets the y-axis object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(in) :: this

    The plot_2d object.

    Return Value class(plot_axis), pointer

    A pointer to the y-axis object.

procedure, public :: initialize => p2d_init

  • private subroutine p2d_init(this, term, fname, err)

    Initializes the plot_2d object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(inout) :: this

    The plot_2d object.
    integer(kind=int32), intent(in), optional :: term

    An optional input that is used to define the terminal. The default terminal is a WXT terminal. The acceptable inputs are:

    • GNUPLOT_TERMINAL_PNG

    • GNUPLOT_TERMINAL_QT

    • GNUPLOT_TERMINAL_WIN32

    • GNUPLOT_TERMINAL_WXT

    • GNUPLOT_TERMINAL_LATEX
    character(len=*), intent(in), optional :: fname

    A filename to pass to the terminal in the event the terminal is a file type (e.g. GNUPLOT_TERMINAL_PNG).
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: is_title_defined => plt_has_title

  • private pure function plt_has_title(this) result(x)

    Gets a value determining if a title has been defined for the plot object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.

    Return Value logical

    Returns true if a title has been defined for this plot; else, returns false.

procedure, public :: pop => plt_pop_data

  • private subroutine plt_pop_data(this)

    Pops the last plot_data object from the stack.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: pop_arrow => plt_pop_arrow

  • private subroutine plt_pop_arrow(this)

    Pops the last plot_arrow object from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: pop_label => plt_pop_label

  • private subroutine plt_pop_label(this)

    Removes the last label from the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.

procedure, public :: push => plt_push_data

  • private subroutine plt_push_data(this, x, err)

    Pushes a plot_data object onto the stack.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    class(plot_data), intent(inout) :: x

    The plot_data object.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: push_arrow => plt_push_arrow

  • private subroutine plt_push_arrow(this, x, err)

    Pushes a new @ref plot_arrow object onto the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    class(plot_arrow), intent(in) :: x

    The plot_arrow object.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: push_label => plt_push_label

  • private subroutine plt_push_label(this, lbl, err)

    Adds a label to the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    class(plot_label), intent(in) :: lbl

    The plot label.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: save_file => plt_save

  • private subroutine plt_save(this, fname, err)

    Saves a GNUPLOT command file.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(in) :: this

    The plot object.
    character(len=*), intent(in) :: fname

    The filename.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: set => plt_set

  • private subroutine plt_set(this, i, x)

    Sets the requested plot_data object into the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_data object.
    class(plot_data), intent(in) :: x

    The plot_data object.

procedure, public :: set_arrow => plt_set_arrow

  • private subroutine plt_set_arrow(this, i, x)

    Sets a plot_arrow into the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_arrow object to replace.
    class(plot_arrow), intent(in) :: x

    The new plot_arrow object.

procedure, public :: set_axis_equal => plt_set_axis_equal

  • private subroutine plt_set_axis_equal(this, x)

    Sets a flag determining if the axes should be equally scaled.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    logical, intent(in) :: x

    Set to true if the axes should be scaled equally; else, false.

procedure, public :: set_bar_width => pb_set_bar_width

  • private subroutine pb_set_bar_width(this, x)

    Sets the bar width scaling factor.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_bar), intent(inout) :: this

    The plot_bar object.
    real(kind=real32), intent(in) :: x

    The scaling factor. The value must be in the set [0, 1]; else, the value will be shifted accordingly.

procedure, public :: set_colormap => plt_set_colormap

  • private subroutine plt_set_colormap(this, x, err)

    Sets the colormap object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    class(colormap), intent(in) :: x

    The colormap object. Notice, a copy of this object is stored, and the plot object then manages the lifetime of the copy.
    class(errors), intent(inout), optional, target :: err

    An error handler object.

procedure, public :: set_draw_border => plt_set_draw_border

  • private subroutine plt_set_draw_border(this, x)

    Sets a value determining if the border should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    logical, intent(in) :: x

    Set to true if the border should be drawn; else, false.

procedure, public :: set_font_name => plt_set_font

  • private subroutine plt_set_font(this, x)

    Sets the name of the font used for plot text.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    character(len=*), intent(in) :: x

    The font name.

procedure, public :: set_font_size => plt_set_font_size

  • private subroutine plt_set_font_size(this, x)

    Sets the size of the font used by the plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    integer(kind=int32), intent(in) :: x

    The font size, in points. If a value of zero is provided, the font size is reset to its default value; or, if a negative value is provided, the absolute value of the supplied value is utilized.

procedure, public :: set_label => plt_set_label

  • private subroutine plt_set_label(this, i, x)

    Sets the specified plot_label object.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    integer(kind=int32), intent(in) :: i

    The index of the plot_label to replace.
    class(plot_label), intent(in) :: x

    The new plot_label object.

procedure, public :: set_show_colorbar => plt_set_show_colorbar

  • private subroutine plt_set_show_colorbar(this, x)

    Sets a value determining if the colorbar should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    logical, intent(in) :: x

    Set to true if the colorbar should be drawn; else, false.

procedure, public :: set_show_gridlines => plt_set_show_grid

  • private subroutine plt_set_show_grid(this, x)

    Sets a flag determining if the grid lines should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    logical, intent(in) :: x

    Set to true if the grid lines should be shown; else, false.

procedure, public :: set_square_axes => p2d_set_square_axes

  • private subroutine p2d_set_square_axes(this, x)

    Sets a logical flag determining if the axes size should be squared off.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(inout) :: this

    The plot_2d object.
    logical, intent(in) :: x

    Set to true if the axes are to be sized to a square; else, false.

procedure, public :: set_tics_inward => plt_set_tics_in

  • private subroutine plt_set_tics_in(this, x)

    Sets a value determining if the axis tic marks should point inwards.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    logical, intent(in) :: x

    Set to true if the tic marks should point inwards; else, false if the tic marks should point outwards.

procedure, public :: set_title => plt_set_title

  • private subroutine plt_set_title(this, txt)

    Sets the plot's title.

    Arguments

    Type IntentOptional Attributes Name
    class(plot), intent(inout) :: this

    The plot object.
    character(len=*), intent(in) :: txt

    The title.

procedure, public :: set_use_y2_axis => p2d_set_use_y2

  • private subroutine p2d_set_use_y2(this, x)

    Sets a flag determining if the secondary y-axis should be displayed.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_2d), intent(inout) :: this

    The plot_2d object.
    logical, intent(in) :: x

    Set to true if the axis should be displayed; else, false.