fplot 1.7.1
A Fortran library providing a convenient interface for plotting with Gnuplot.
|
Defines the basic GNUPLOT plot. More...
Public Member Functions | |
procedure, public | free_resources plt_clean_up |
Cleans up resources held by the plot object. Inheriting classes are expected to call this routine to free internally held resources. | |
procedure, public | initialize plt_init |
Initializes the plot object. | |
procedure, public | get_title plt_get_title |
Gets the plot's title. | |
procedure, public | set_title plt_set_title |
Sets the plot's title. | |
procedure, public | is_title_defined plt_has_title |
Gets a value determining if a title has been defined for the plot object. | |
procedure, public | get_legend plt_get_legend |
Gets the plot's legend object. | |
procedure, public | get_count plt_get_count |
Gets the number of stored plot_data objects. | |
procedure, public | push plt_push_data |
Pushes a plot_data object onto the stack. | |
procedure, public | pop plt_pop_data |
Pops the last plot_data object from the stack. | |
procedure, public | clear_all plt_clear_all |
Removes all plot_data objects from the plot. | |
procedure, public | get plt_get |
Gets a pointer to the requested plot_data object. | |
procedure, public | set plt_set |
Sets the requested plot_data object into the plot. | |
procedure, public | get_terminal plt_get_term |
Gets the GNUPLOT terminal object. | |
procedure, public | get_show_gridlines plt_get_show_grid |
Gets a flag determining if the grid lines should be shown. | |
procedure, public | set_show_gridlines plt_set_show_grid |
Sets a flag determining if the grid lines should be shown. | |
procedure, public | draw plt_draw |
Launches GNUPLOT and draws the plot per the current state of the command list. | |
procedure, public | save_file plt_save |
Saves a GNUPLOT command file. | |
procedure, public | get_font_name plt_get_font |
Gets the name of the font used for plot text. | |
procedure, public | set_font_name plt_set_font |
Sets the name of the font used for plot text. | |
procedure, public | get_font_size plt_get_font_size |
Gets the size of the font used by the plot. | |
procedure, public | set_font_size plt_set_font_size |
Sets the size of the font used by the plot. | |
procedure, public | get_tics_inward plt_get_tics_in |
Gets a value determining if the axis tic marks should point inwards. | |
procedure, public | set_tics_inward plt_set_tics_in |
Sets a value determining if the axis tic marks should point inwards. | |
procedure, public | get_draw_border plt_get_draw_border |
Gets a value determining if the border should be drawn. | |
procedure, public | set_draw_border plt_set_draw_border |
Sets a value determining if the border should be drawn. | |
procedure, public | push_label plt_push_label |
Adds a label to the plot. | |
procedure, public | pop_label plt_pop_label |
Removes the last label from the plot. | |
procedure, public | get_label plt_get_label |
Gets the requested plot_label from the plot. | |
procedure, public | set_label plt_set_label |
Sets the specified plot_label object. | |
procedure, public | get_label_count plt_get_label_count |
Gets the number of plot_label objects belonging to the plot. | |
procedure, public | clear_all_labels plt_clear_labels |
Clears all plot_label objects from the plot. | |
procedure, public | get_axis_equal plt_get_axis_equal |
Gets a flag determining if the axes should be equally scaled. | |
procedure, public | set_axis_equal plt_set_axis_equal |
Sets a flag determining if the axes should be equally scaled. | |
procedure, public | get_colormap plt_get_colormap |
Gets a pointer to the colormap object. | |
procedure, public | set_colormap plt_set_colormap |
Sets the colormap object. | |
procedure, public | get_show_colorbar plt_get_show_colorbar |
Gets a value determining if the colorbar should be shown. | |
procedure, public | set_show_colorbar plt_set_show_colorbar |
Sets a value determining if the colorbar should be shown. | |
procedure, public | get_command_string plt_get_cmd |
Gets the GNUPLOT command string to represent this plot object. | |
procedure, public | push_arrow plt_push_arrow |
Pushes a new plot_arrow object onto the plot. | |
procedure, public | pop_arrow plt_pop_arrow |
Pops a plot_arrow object from the plot. | |
procedure, public | get_arrow plt_get_arrow |
Gets a pointer to the requested plot_arrow object. | |
procedure, public | set_arrow plt_set_arrow |
Sets a plot_arrow into the plot. | |
procedure, public | get_arrow_count plt_get_arrow_count |
Gets the number of plot_arrow objects held by the plot object. | |
procedure, public | clear_arrows plt_clear_arrows |
Clears all plot_arrow objects from the plot. | |
Public Attributes | |
logical | m_hastitle = .false. |
Has a title? | |
class(terminal), pointer | m_terminal => null() |
The GNUPLOT terminal object to target. | |
type(list) | m_data |
A collection of plot_data items to plot. | |
type(legend), pointer | m_legend => null() |
The legend. | |
logical | m_showgrid = .true. |
Show grid lines? | |
logical | m_ticsin = .true. |
Point tic marks in? | |
logical | m_drawborder = .true. |
Draw the border? | |
type(list) | m_labels |
A collection of plot_label items to draw. | |
integer(int32) | m_colorindex = 1 |
The color index to use for automatic line coloring for scatter plots. | |
logical | m_axisequal = .false. |
Determines if the axes should be scaled proportionally. | |
class(colormap), pointer | m_colormap |
The colormap. | |
logical | m_showcolorbar = .true. |
Show the colorbar? | |
type(list) | m_arrows |
A collection of plot_arrow items to draw. | |
Private Attributes | |
character(len=plotdata_max_name_length) | m_title = "" |
The plot title. | |
Defines the basic GNUPLOT plot.
Definition at line 2772 of file fplot_core.f90.
procedure, public fplot_core::plot::clear_all |
Removes all plot_data objects from the plot.
[in,out] | this | The plot object. |
Definition at line 2925 of file fplot_core.f90.
procedure, public fplot_core::plot::clear_all_labels |
Clears all plot_label objects from the plot.
[in,out] | this | The plot object. |
Definition at line 3161 of file fplot_core.f90.
procedure, public fplot_core::plot::clear_arrows |
Clears all plot_arrow objects from the plot.
[in,out] | this | The plot object. |
Definition at line 3309 of file fplot_core.f90.
procedure, public fplot_core::plot::draw |
Launches GNUPLOT and draws the plot per the current state of the command list.
[in] | this | The plot object. |
[in] | 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. |
[in,out] | err | An 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.
|
Definition at line 2996 of file fplot_core.f90.
procedure, public fplot_core::plot::free_resources |
Cleans up resources held by the plot object. Inheriting classes are expected to call this routine to free internally held resources.
[in,out] | this | The plot object. |
Definition at line 2813 of file fplot_core.f90.
procedure, public fplot_core::plot::get |
Gets a pointer to the requested plot_data object.
[in] | this | The plot object. |
[in] | i | The index of the plot_data object. |
Definition at line 2936 of file fplot_core.f90.
procedure, public fplot_core::plot::get_arrow |
Gets a pointer to the requested plot_arrow object.
[in] | this | The plot object. |
[in] | i | The index of the plot_arrow to retrieve. |
Definition at line 3276 of file fplot_core.f90.
procedure, public fplot_core::plot::get_arrow_count |
Gets the number of plot_arrow objects held by the plot object.
[in] | this | The plot object. |
Definition at line 3300 of file fplot_core.f90.
procedure, public fplot_core::plot::get_axis_equal |
Gets a flag determining if the axes should be equally scaled.
[in] | this | The plot object. |
Definition at line 3172 of file fplot_core.f90.
procedure, public fplot_core::plot::get_colormap |
Gets a pointer to the colormap object.
[in] | this | The plot object. |
Definition at line 3194 of file fplot_core.f90.
|
virtual |
Gets the GNUPLOT command string to represent this plot object.
[in] | this | The plot object. |
Implements fplot_core::plot_object.
Reimplemented in fplot_core::plot_2d, fplot_core::plot_3d, fplot_core::plot_bar, fplot_core::plot_polar, and fplot_core::surface_plot.
Definition at line 3243 of file fplot_core.f90.
procedure, public fplot_core::plot::get_count |
Gets the number of stored plot_data objects.
[in] | this | The plot object. |
Definition at line 2891 of file fplot_core.f90.
procedure, public fplot_core::plot::get_draw_border |
Gets a value determining if the border should be drawn.
[in] | this | The plot object. |
Definition at line 3088 of file fplot_core.f90.
procedure, public fplot_core::plot::get_font_name |
Gets the name of the font used for plot text.
[in] | this | The plot object. |
Definition at line 3022 of file fplot_core.f90.
procedure, public fplot_core::plot::get_font_size |
Gets the size of the font used by the plot.
[in] | this | The plot object. |
Definition at line 3042 of file fplot_core.f90.
procedure, public fplot_core::plot::get_label |
Gets the requested plot_label from the plot.
[in] | this | The plot object. |
[in] | i | The index of the plot_label object to retrieve. |
Definition at line 3131 of file fplot_core.f90.
procedure, public fplot_core::plot::get_label_count |
Gets the number of plot_label objects belonging to the plot.
[in] | this | The plot object. |
Definition at line 3152 of file fplot_core.f90.
procedure, public fplot_core::plot::get_legend |
Gets the plot's legend object.
[in] | this | The plot object. |
Definition at line 2881 of file fplot_core.f90.
procedure, public fplot_core::plot::get_show_colorbar |
Gets a value determining if the colorbar should be shown.
[in] | this | The plot object. |
Definition at line 3222 of file fplot_core.f90.
procedure, public fplot_core::plot::get_show_gridlines |
Gets a flag determining if the grid lines should be shown.
[in] | this | The plot object. |
Definition at line 2967 of file fplot_core.f90.
procedure, public fplot_core::plot::get_terminal |
Gets the GNUPLOT terminal object.
[in] | this | The plot object. |
Definition at line 2957 of file fplot_core.f90.
procedure, public fplot_core::plot::get_tics_inward |
Gets a value determining if the axis tic marks should point inwards.
[in] | this | The plot object. |
Definition at line 3066 of file fplot_core.f90.
procedure, public fplot_core::plot::get_title |
Gets the plot's title.
[in] | this | The plot object. |
Definition at line 2847 of file fplot_core.f90.
procedure, public fplot_core::plot::initialize |
Initializes the plot object.
[in,out] | this | The plot object. |
[in] | term | An optional input that is used to define the terminal. The default terminal is a WXT terminal. The acceptable inputs are:
|
[in] | fname | A filename to pass to the terminal in the event the terminal is a file type (e.g. GNUPLOT_TERMINAL_PNG). |
[in,out] | err | An 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.
|
Definition at line 2837 of file fplot_core.f90.
procedure, public fplot_core::plot::is_title_defined |
Gets a value determining if a title has been defined for the plot object.
[in] | this | The plot object. |
Definition at line 2871 of file fplot_core.f90.
procedure, public fplot_core::plot::pop |
Pops the last plot_data object from the stack.
[in,out] | this | The plot object. |
Definition at line 2916 of file fplot_core.f90.
procedure, public fplot_core::plot::pop_arrow |
Pops a plot_arrow object from the plot.
[in,out] | this | The plot object. |
Definition at line 3266 of file fplot_core.f90.
procedure, public fplot_core::plot::pop_label |
Removes the last label from the plot.
[in,out] | this | The plot object. |
Definition at line 3120 of file fplot_core.f90.
procedure, public fplot_core::plot::push |
Pushes a plot_data object onto the stack.
[in,out] | this | The plot object. |
[in] | x | The plot_data object. |
[in,out] | err | An 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.
|
Definition at line 2907 of file fplot_core.f90.
procedure, public fplot_core::plot::push_arrow |
Pushes a new plot_arrow object onto the plot.
[in,out] | this | The plot object. |
[in] | x | The plot_arrow object. This instance is copied, and the copy is stored and managed by the plot object. |
[in,out] | err | An optional errors-based object for managing errors. The default implementation of the errors type is used if nothing is supplied. |
Definition at line 3257 of file fplot_core.f90.
procedure, public fplot_core::plot::push_label |
Adds a label to the plot.
[in,out] | this | The plot object. |
[in] | lbl | The plot label. |
[in,out] | err | An optional errors-based object for managing errors. The default implementation of the errors type is used if nothing is supplied. |
Definition at line 3111 of file fplot_core.f90.
procedure, public fplot_core::plot::save_file |
Saves a GNUPLOT command file.
[in] | this | The plot object. |
[in] | fname | The filename. |
[in,out] | err | An 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.
|
Definition at line 3012 of file fplot_core.f90.
procedure, public fplot_core::plot::set |
Sets the requested plot_data object into the plot.
[in,out] | this | The plot object. |
[in] | i | The index of the plot_data object. |
[in] | x | The plot_data object. |
Definition at line 2947 of file fplot_core.f90.
procedure, public fplot_core::plot::set_arrow |
Sets a plot_arrow into the plot.
[in,out] | this | The plot object. |
[in] | i | The index of the plot_arrow to retrieve. |
[in] | x | The plot_arrow to set. This instance is copied, and the copy is stored and managed by the plot object. |
Definition at line 3288 of file fplot_core.f90.
procedure, public fplot_core::plot::set_axis_equal |
Sets a flag determining if the axes should be equally scaled.
[in,out] | this | The plot object. |
[in] | x | Set to true if the axes should be scaled equally; else, false. |
Definition at line 3183 of file fplot_core.f90.
procedure, public fplot_core::plot::set_colormap |
Sets the colormap object.
[in,out] | this | The plot object. |
[in] | x | The colormap object. Notice, a copy of this object is stored, and the plot object then manages the lifetime of the copy. |
[out] | err | An 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.
|
Definition at line 3212 of file fplot_core.f90.
procedure, public fplot_core::plot::set_draw_border |
Sets a value determining if the border should be drawn.
[in,out] | this | The plot object. |
[in] | x | Set to true if the border should be drawn; else, false. |
Definition at line 3098 of file fplot_core.f90.
procedure, public fplot_core::plot::set_font_name |
Sets the name of the font used for plot text.
[in,out] | this | The plot object. |
[in] | x | The font name. |
Definition at line 3032 of file fplot_core.f90.
procedure, public fplot_core::plot::set_font_size |
Sets the size of the font used by the plot.
[in,out] | this | The plot object. |
[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. |
Definition at line 3054 of file fplot_core.f90.
procedure, public fplot_core::plot::set_label |
Sets the specified plot_label object.
[in,out] | this | The plot object. |
[in] | i | The index of the plot_label to replace. |
[in] | x | The new plot_label object. |
Definition at line 3142 of file fplot_core.f90.
procedure, public fplot_core::plot::set_show_colorbar |
Sets a value determining if the colorbar should be shown.
[in,out] | this | The plot object. |
[in] | x | Set to true if the colorbar should be drawn; else, false. |
Definition at line 3232 of file fplot_core.f90.
procedure, public fplot_core::plot::set_show_gridlines |
Sets a flag determining if the grid lines should be shown.
[in,out] | this | The plot object. |
[in] | x | Set to true if the grid lines should be shown; else, false. |
Definition at line 2977 of file fplot_core.f90.
procedure, public fplot_core::plot::set_tics_inward |
Sets a value determining if the axis tic marks should point inwards.
[in,out] | this | The plot object. |
[in] | x | Set to true if the tic marks should point inwards; else, false if the tic marks should point outwards. |
Definition at line 3078 of file fplot_core.f90.
procedure, public fplot_core::plot::set_title |
Sets the plot's title.
[in,out] | this | The plot object. |
[in] | txt | The plot's title. The number of characters must be less than or equal to PLOTDATA_MAX_NAME_LENGTH; else, the text string is truncated. |
Definition at line 2859 of file fplot_core.f90.
type(list) fplot_core::plot::m_arrows |
A collection of plot_arrow items to draw.
Definition at line 2801 of file fplot_core.f90.
logical fplot_core::plot::m_axisequal = .false. |
Determines if the axes should be scaled proportionally.
Definition at line 2795 of file fplot_core.f90.
integer(int32) fplot_core::plot::m_colorindex = 1 |
The color index to use for automatic line coloring for scatter plots.
Definition at line 2793 of file fplot_core.f90.
class(colormap), pointer fplot_core::plot::m_colormap |
The colormap.
Definition at line 2797 of file fplot_core.f90.
type(list) fplot_core::plot::m_data |
A collection of plot_data items to plot.
Definition at line 2781 of file fplot_core.f90.
logical fplot_core::plot::m_drawborder = .true. |
Draw the border?
Definition at line 2789 of file fplot_core.f90.
logical fplot_core::plot::m_hastitle = .false. |
Has a title?
Definition at line 2777 of file fplot_core.f90.
type(list) fplot_core::plot::m_labels |
A collection of plot_label items to draw.
Definition at line 2791 of file fplot_core.f90.
type(legend), pointer fplot_core::plot::m_legend => null() |
The legend.
Definition at line 2783 of file fplot_core.f90.
logical fplot_core::plot::m_showcolorbar = .true. |
Show the colorbar?
Definition at line 2799 of file fplot_core.f90.
logical fplot_core::plot::m_showgrid = .true. |
Show grid lines?
Definition at line 2785 of file fplot_core.f90.
class(terminal), pointer fplot_core::plot::m_terminal => null() |
The GNUPLOT terminal object to target.
Definition at line 2779 of file fplot_core.f90.
logical fplot_core::plot::m_ticsin = .true. |
Point tic marks in?
Definition at line 2787 of file fplot_core.f90.
|
private |
The plot title.
Definition at line 2775 of file fplot_core.f90.