fplot 1.7.1
A Fortran library providing a convenient interface for plotting with Gnuplot.
Loading...
Searching...
No Matches
fplot_core::filled_plot_data Type Reference

Defines a two-dimensional filled plot data set. More...

Inheritance diagram for fplot_core::filled_plot_data:
fplot_core::plot_data_colored fplot_core::plot_data fplot_core::plot_object

Public Member Functions

procedure, public get_axes_string fpd_get_axes_cmd
 Gets the GNUPLOT command string defining which axes the data is to be plotted against.
 
procedure, public get_draw_against_y2 fpd_get_draw_against_y2
 Gets a value determining if the data should be plotted against the secondary y-axis.
 
procedure, public set_draw_against_y2 fpd_set_draw_against_y2
 Sets a value determining if the data should be plotted against the secondary y-axis.
 
procedure, public get_command_string fpd_get_cmd
 Gets the GNUPLOT command string to represent this filled_plot_data object.
 
procedure, public get_data_string fpd_get_data_cmd
 Gets the GNUPLOT command string containing the actual data to plot.
 
procedure, public define_data fpd_define_data
 Defines the data set.
 
- Public Member Functions inherited from fplot_core::plot_data_colored
procedure, public get_line_color pdc_get_line_color
 Gets the line color.
 
procedure, public set_line_color pdc_set_line_color
 Sets the line color.
 
- Public Member Functions inherited from fplot_core::plot_data
procedure, public get_name pd_get_name
 Gets the name to associate with this data set.
 
procedure, public set_name pd_set_name
 Sets the name to associate with this data set.
 

Public Attributes

real(real64), dimension(:,:), allocatable m_data
 The data set (column 1 = x, column 2 = y, column 3 = constraint y)
 
- Public Attributes inherited from fplot_core::plot_data_colored
logical m_useautocolor = .true.
 Let the object choose colors automatically.
 
integer(int32) m_colorindex = 1
 The color index to use, assuming we're using auto color.
 

Private Attributes

logical m_usey2 = .false.
 Plot against the secondary y-axis.
 

Detailed Description

Defines a two-dimensional filled plot data set.

Definition at line 7586 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ define_data()

procedure, public fplot_core::filled_plot_data::define_data

Defines the data set.

Syntax
subroutine define_data(class(filled_plot_data) this, real(real64) x(:), real(real64) y(:), real(real64) yc(:))
Parameters
[in,out]thisThe filled_plot_data object.
[in]xAn N-element array containing the x coordinate data.
[in]yAn N-element array containing the y coordinate data.
[in]ycAn N-element array containing the constraining curve y coordinate data.
[out]errAn optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows.
  • PLOT_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available.
  • PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if x and y are not the same size.

Definition at line 7669 of file fplot_core.f90.

◆ get_axes_string()

procedure, public fplot_core::filled_plot_data::get_axes_string

Gets the GNUPLOT command string defining which axes the data is to be plotted against.

Syntax
character(len = :) function, allocatable get_axis_string(class(filled_plot_data) this)
Parameters
[in]thisThe filled_plot_data object.
Returns
The command string.

Definition at line 7603 of file fplot_core.f90.

◆ get_command_string()

procedure, public fplot_core::filled_plot_data::get_command_string
virtual

Gets the GNUPLOT command string to represent this filled_plot_data object.

Syntax
character(len = :) function, allocatable get_command_string(class(filled_plot_data) this)
Parameters
[in]thisThe filled_plot_data object.
Returns
The command string.

Implements fplot_core::plot_object.

Definition at line 7638 of file fplot_core.f90.

◆ get_data_string()

procedure, public fplot_core::filled_plot_data::get_data_string
virtual

Gets the GNUPLOT command string containing the actual data to plot.

Syntax
character(len = :) function, allocatable get_data_string(class(filled_plot_data) this)
Parameters
[in]thisThe filled_plot_data object.
Returns
The command string.

Implements fplot_core::plot_data.

Definition at line 7649 of file fplot_core.f90.

◆ get_draw_against_y2()

procedure, public fplot_core::filled_plot_data::get_draw_against_y2

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

Syntax
pure logical function get_draw_against_y2(class(filled_plot_data) this)
Parameters
[in]thisThe filled_plot_data object.
Returns
Returns true if the data should be plotted against the secondary y-axis; else, false to plot against the primary y-axis.

Definition at line 7615 of file fplot_core.f90.

◆ set_draw_against_y2()

procedure, public fplot_core::filled_plot_data::set_draw_against_y2

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

Syntax
subroutine set_draw_against_y2(class(filled_plot_data) this, logical x)
Parameters
[in,out]thisThe filled_plot_data object.
[in]xSet to true if the data should be plotted against the secondary y-axis; else, false to plot against the primary y-axis.

Definition at line 7627 of file fplot_core.f90.

Member Data Documentation

◆ m_data

real(real64), dimension(:,:), allocatable fplot_core::filled_plot_data::m_data

The data set (column 1 = x, column 2 = y, column 3 = constraint y)

Definition at line 7591 of file fplot_core.f90.

◆ m_usey2

logical fplot_core::filled_plot_data::m_usey2 = .false.
private

Plot against the secondary y-axis.

Definition at line 7589 of file fplot_core.f90.


The documentation for this type was generated from the following file: