plot_data_bar Derived Type

type, public, extends(plot_data_colored) :: plot_data_bar

Defines a data set tailored to bar charts.


Contents

Type-Bound Procedures


Type-Bound Procedures

generic, public :: define_data => pdb_set_data_1, pdb_set_data_2, pdb_set_data_3

  • private subroutine pdb_set_data_1(this, x, err)

    Defines a single data set.

    Arguments

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

    The plot_data_bar object.
    real(kind=real64), intent(in), dimension(:) :: x

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

    An error handling object.

  • private subroutine pdb_set_data_2(this, labels, x, err)

    Defines data along with associated axis labels.

    Arguments

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

    The plot_data_bar object.
    class(string), intent(in), dimension(:) :: labels

    The axis labels to associate with the data.
    real(kind=real64), intent(in), dimension(:) :: x

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

    An error handling object.

  • private subroutine pdb_set_data_3(this, labels, x, fmt, err)

    Defines data along with labels and formatting information.

    Arguments

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

    The plot_data_bar object.
    real(kind=real64), intent(in), dimension(:) :: labels

    The axis labels to associate with the data.
    real(kind=real64), intent(in), dimension(:) :: x

    The data set.
    character(len=*), intent(in), optional :: fmt

    The format string for the labels (e.g. '(I0)', etc.).
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: get => pdb_get_data

  • private pure function pdb_get_data(this, index, col) result(x)

    Gets the requested data point.

    Arguments

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

    The plot_data_bar object.
    integer(kind=int32), intent(in) :: index

    The data point index.
    integer(kind=int32), intent(in) :: col

    The column index.

    Return Value real(kind=real64)

    The value.

procedure, public :: get_axes_string => pdb_get_axes_cmd

  • private function pdb_get_axes_cmd(this) result(x)

    Gets the GNUPLOT command defining which axes to plot against.

    Arguments

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

    The plot_data_bar object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_bar_per_label_count => pdb_get_col_count

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

    Gets the number of data sets (columns).

    Arguments

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

    The plot_data_bar object.

    Return Value integer(kind=int32)

    The count.

procedure, public :: get_color_index => pdc_get_color_index

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

    Gets the color index.

    Arguments

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

    The plot_data_colored object.

    Return Value integer(kind=int32)

    The index value.

procedure, public :: get_command_string => pdb_get_cmd

  • private function pdb_get_cmd(this) result(x)

    Gets the GNUPLOT command string for this object.

    Arguments

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

    The plot_data_bar object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_count => pdb_get_count

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

    Gets the number of stored data points.

    Arguments

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

    The plot_data_bar object.

    Return Value integer(kind=int32)

    The number of stored data points.

procedure, public :: get_data => pdb_get_data_set

  • private pure function pdb_get_data_set(this, col) result(x)

    Gets the requested data set.

    Arguments

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

    The plot_data_bar object.
    integer(kind=int32), intent(in) :: col

    The column index.

    Return Value real(kind=real64), allocatable, dimension(:)

    A copy of the data set.

procedure, public :: get_data_string => pdb_get_data_cmd

  • private function pdb_get_data_cmd(this) result(x)

    Gets the GNUPLOT command string defining the data for this object.

    Arguments

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

    The plot_data_bar object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_draw_against_y2 => pdb_get_use_y2

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

    Gets a value determining if the data should be plotted against a secondary y-axis.

    Arguments

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

    The plot_data_bar object.

    Return Value logical

    Returns true to plot against a secondary y-axis; else, false.

procedure, public :: get_is_filled => pdb_get_is_filled

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

    Gets a value determining if each bar is filled.

    Arguments

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

    The plot_data_bar object.

    Return Value logical

    Returns true if the bars are to be filled; else, false.

procedure, public :: get_label => pdb_get_label

  • private pure function pdb_get_label(this, index) result(x)

    Gets the axis label associated with a specific data set.

    Arguments

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

    The plot_data_bar object.
    integer(kind=int32), intent(in) :: index

    The index of the data set.

    Return Value character(len=:), allocatable

    The label.

procedure, public :: get_line_color => pdc_get_line_color

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

    Gets the object color.

    Arguments

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

    The plot_data_colored object.

    Return Value type(color)

    The color.

procedure, public :: get_name => pd_get_name

  • private pure function pd_get_name(this) result(txt)

    Gets the name to associate with this data set.

    Arguments

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

    The plot_data object.

    Return Value character(len=:), allocatable

    The name.

procedure, public :: get_transparency => pdb_get_alpha

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

    Gets the alpha (transparency) for the bar color.

    Arguments

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

    The plot_data_bar object.

    Return Value real(kind=real32)

    The alpha value ([0, 1]).

procedure, public :: get_use_labels => pdb_get_use_labels

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

    Gets a value determining if labels are used to identify the data.

    Arguments

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

    The plot_data_bar object.

    Return Value logical

    Returns true if labels are used; else, false.

procedure, public :: set => pdb_set_data

  • private subroutine pdb_set_data(this, index, col, x)

    Replaces the requested data point.

    Arguments

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

    The plot_data_bar object.
    integer(kind=int32), intent(in) :: index

    The data point index.
    integer(kind=int32), intent(in) :: col

    The column index.
    real(kind=real64), intent(in) :: x

    The new value.

procedure, public :: set_color_index => pdc_set_color_index

  • private subroutine pdc_set_color_index(this, x)

    Sets the color index.

    Arguments

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

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

    The index value.

procedure, public :: set_data_1 => pdb_set_data_1_core

  • private subroutine pdb_set_data_1_core(this, x, err)

    Defines the data set.

    Arguments

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

    The plot_data_bar object.
    real(kind=real64), intent(in), dimension(:) :: x

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

    An error handling object.

procedure, public :: set_data_2 => pdb_set_data_2_core

  • private subroutine pdb_set_data_2_core(this, labels, x, err)

    Arguments

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

    The plot_data_bar object.
    class(string), intent(in), dimension(:) :: labels

    The axis labels.
    real(kind=real64), intent(in), dimension(:) :: x

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

    An error handling object.

procedure, public :: set_data_3 => pdb_set_data_3_core

  • private subroutine pdb_set_data_3_core(this, labels, x, fmt, err)

    Arguments

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

    The plot_data_bar object.
    real(kind=real64), intent(in), dimension(:) :: labels

    The axis labels.
    real(kind=real64), intent(in), dimension(:) :: x

    The data set.
    character(len=*), intent(in), optional :: fmt

    The format string for the labels (e.g. '(I0)', etc.).
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: set_draw_against_y2 => pdb_set_use_y2

  • private subroutine pdb_set_use_y2(this, x)

    Sets a value determining if the data should be plotted against a secondary y-axis.

    Arguments

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

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

    Set to true to plot against a secondary y-axis; else, false.

procedure, public :: set_is_filled => pdb_set_is_filled

  • private subroutine pdb_set_is_filled(this, x)

    Sets a value determining if each bar is filled.

    Arguments

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

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

    Set to true if the bars are to be filled; else, false.

procedure, public :: set_label => pdb_set_label

  • private subroutine pdb_set_label(this, index, txt)

    Sets the axis label for a specific data set.

    Arguments

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

    The plot_data_bar object.
    integer(kind=int32) :: index

    The index of the data set.
    character(len=*), intent(in) :: txt

    The label.

procedure, public :: set_line_color => pdc_set_line_color

  • private subroutine pdc_set_line_color(this, x)

    Sets the object color.

    Arguments

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

    The plot_data_colored object.
    type(color), intent(in) :: x

    The color.

procedure, public :: set_name => pd_set_name

  • private subroutine pd_set_name(this, txt)

    Sets the name to associate with this data set.

    Arguments

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

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

    The name.

procedure, public :: set_transparency => pdb_set_alpha

  • private subroutine pdb_set_alpha(this, x)

    Gets the alpha (transparency) for the bar color.

    Arguments

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

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

    The alpha value ([0, 1]).

procedure, public :: set_use_labels => pdb_set_use_labels

  • private subroutine pdb_set_use_labels(this, x)

    Sets a value determining if labels are used to identify the data.

    Arguments

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

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

    Set to true if labels are used; else, false.