Defines a multi-plot layout. More...

Inheritance diagram for fplot_core::multiplot:

Public Member Functions
procedure, public	get_command_string mp_get_command
	Returns the appropriate GNUPLOT command string to define the plot object properties.

procedure, public	initialize mp_init
	Initializes the multiplot object.

procedure, public	get_row_count mp_get_rows
	Gets the number of rows of plots.

procedure, public	get_column_count mp_get_cols
	Gets the number of columns of plots.

procedure, public	get_plot_count mp_get_count
	Gets the number of plots.

procedure, public	get_title mp_get_title
	Gets the multiplot's title.

procedure, public	set_title mp_set_title
	Sets the multiplot's title.

procedure, public	draw mp_draw
	Launches GNUPLOT and draws the multiplot per the current state of the command list.

procedure, public	get mp_get
	Gets the requested plot object.

procedure, public	set mp_set
	Sets the requested plot object.

procedure, public	is_title_defined mp_has_title
	Gets a value determining if a title has been defined for the multiplot object.

procedure, public	get_terminal mp_get_term
	Gets the GNUPLOT terminal object.

procedure, public	save_file mp_save
	Saves a GNUPLOT command file.

procedure, public	get_font_name mp_get_font
	Gets the name of the font used for plot text.

procedure, public	set_font_name mp_set_font
	Sets the name of the font used for plot text.

procedure, public	get_font_size mp_get_font_size
	Gets the size of the font used by the plot.

procedure, public	set_font_size mp_set_font_size
	Sets the size of the font used by the plot.

Public Attributes
type(list)	m_plots
	The collection of plot objects.

integer(int32)	m_rows = 0
	The number of rows of plots.

integer(int32)	m_cols = 0
	The number of columns of plots.

character(len=plotdata_max_name_length)	m_title
	The page title.

logical	m_hastitle = .false.
	Has a title?

class(terminal), pointer	m_terminal => null()
	The BNUPLOT terminal object to target.

Detailed Description

Defines a multi-plot layout.

Definition at line 5857 of file fplot_core.f90.

Constructor & Destructor Documentation

◆ mp_clean()

final fplot_core::multiplot::mp_clean

final

Definition at line 5871 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ draw()

procedure, public fplot_core::multiplot::draw

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

Syntax: subroutine draw(class(multiplot) this, optional logical persist, optional class(errors) err)

Parameters

[in]	this	The multiplot 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. PLOT_GNUPLOT_FILE_ERROR: Occurs if the command file cannot be written.

Definition at line 5965 of file fplot_core.f90.

◆ get()

procedure, public fplot_core::multiplot::get

Gets the requested plot object.

Syntax: class(plot) pointer function get(class(multiplot) this, integer(int32) i, integer(int32) j)

Parameters

[in]	this	The multiplot object.
[in]	i	The row index of the plot to retrieve.
[in]	j	The column index of the plot to retrieve.

Returns: A pointer to the requested plot object.

Definition at line 5977 of file fplot_core.f90.

◆ get_column_count()

procedure, public fplot_core::multiplot::get_column_count

Gets the number of columns of plots.

Syntax: pure integer(int32) function get_column_count(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: The number of columns.

Definition at line 5914 of file fplot_core.f90.

◆ get_command_string()

procedure, public fplot_core::multiplot::get_command_string

virtual

Returns the appropriate GNUPLOT command string to define the plot object properties.

Implements fplot_core::plot_object.

Definition at line 5872 of file fplot_core.f90.

◆ get_font_name()

procedure, public fplot_core::multiplot::get_font_name

Gets the name of the font used for plot text.

Syntax: character(len = :) function, allocatable get_font_name(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: The font name.

Definition at line 6037 of file fplot_core.f90.

◆ get_font_size()

procedure, public fplot_core::multiplot::get_font_size

Gets the size of the font used by the plot.

Syntax: integer(int32) function get_font_size(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: The size of the font, in points.

Definition at line 6057 of file fplot_core.f90.

◆ get_plot_count()

procedure, public fplot_core::multiplot::get_plot_count

Gets the number of plots.

Syntax: pure integer(int32) function get_plot_count(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: The number of plots.

Definition at line 5924 of file fplot_core.f90.

◆ get_row_count()

procedure, public fplot_core::multiplot::get_row_count

Gets the number of rows of plots.

Syntax: pure integer(int32) function get_row_count(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: The number of rows.

Definition at line 5904 of file fplot_core.f90.

◆ get_terminal()

procedure, public fplot_core::multiplot::get_terminal

Gets the GNUPLOT terminal object.

Syntax: class(terminal) function, pointer get_terminal(class(multiplot) this)

Parameters

[in] this The multiplot object.

Returns: A pointer to the GNUPLOT terminal object.

Definition at line 6011 of file fplot_core.f90.

◆ get_title()

procedure, public fplot_core::multiplot::get_title

Gets the multiplot's title.

Syntax: character(len = :) function, allocatable get_title(class(multiplot))

Parameters

[in] this The multiplot object.

Returns: The multiplot's title.

Definition at line 5934 of file fplot_core.f90.

◆ initialize()

procedure, public fplot_core::multiplot::initialize

Initializes the multiplot object.

Syntax: subroutine initialize(class(multiplot) this, optional class(terminal) term, optional class(errors) err)

Parameters

[in,out]	this	The multiplot object.
[in]	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
[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. PLOT_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available.

Definition at line 5894 of file fplot_core.f90.

◆ is_title_defined()

procedure, public fplot_core::multiplot::is_title_defined

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

Syntax: pure logical function is_title_defined(class(multiplot) this)

Parameters

[in] this The multiplot object.

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

Definition at line 6001 of file fplot_core.f90.

◆ save_file()

procedure, public fplot_core::multiplot::save_file

Saves a GNUPLOT command file.

Syntax: subroutine save_file(class(multiplot) this, character(len = *) fname, optional class(errors) err)

Parameters

[in]	this	The multiplot 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. PLOT_GNUPLOT_FILE_ERROR: Occurs if the command file cannot be written.

Definition at line 6027 of file fplot_core.f90.

◆ set()

procedure, public fplot_core::multiplot::set

Sets the requested plot object.

Syntax: subroutine set(class(multiplot) this, integer(int32) i, integer(int32) j, class(plot) pointer x)

Parameters

[in,out]	this	The multiplot object.
[in]	i	The row index of the plot to retrieve.
[in]	j	The column index of the plot to retrieve.
[in]	x	A pointer to the requested plot object.

Definition at line 5989 of file fplot_core.f90.

◆ set_font_name()

procedure, public fplot_core::multiplot::set_font_name

Sets the name of the font used for plot text.

Syntax: subroutine set_font_name(class(multiplot) this, character(len = *) x)

Parameters

[in,out]	this	The multiplot object.
[in]	x	The font name.

Definition at line 6047 of file fplot_core.f90.

◆ set_font_size()

procedure, public fplot_core::multiplot::set_font_size

Sets the size of the font used by the plot.

Syntax: subroutine set_font_size(class(multiplot) this, integer(int32) x)

Parameters

[in,out]	this	The multiplot 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 6069 of file fplot_core.f90.

◆ set_title()

procedure, public fplot_core::multiplot::set_title

Sets the multiplot's title.

Syntax: subroutine set_title(class(multiplot) this, character(len = *) txt)

Parameters

[in,out]	this	The multiplot object.
[in]	txt	The multiplot'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 5946 of file fplot_core.f90.

Member Data Documentation

◆ m_cols

integer(int32) fplot_core::multiplot::m_cols = 0

The number of columns of plots.

Definition at line 5863 of file fplot_core.f90.

◆ m_hastitle

logical fplot_core::multiplot::m_hastitle = .false.

Has a title?

Definition at line 5867 of file fplot_core.f90.

◆ m_plots

type(list) fplot_core::multiplot::m_plots

The collection of plot objects.

Definition at line 5859 of file fplot_core.f90.

◆ m_rows

integer(int32) fplot_core::multiplot::m_rows = 0

The number of rows of plots.

Definition at line 5861 of file fplot_core.f90.

◆ m_terminal

class(terminal), pointer fplot_core::multiplot::m_terminal => null()

The BNUPLOT terminal object to target.

Definition at line 5869 of file fplot_core.f90.

◆ m_title

character(len = plotdata_max_name_length) fplot_core::multiplot::m_title

The page title.

Definition at line 5865 of file fplot_core.f90.

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

D:/Code/fplot-1/src/fplot_core.f90

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mp_clean()

Member Function/Subroutine Documentation

◆ draw()

◆ get()

◆ get_column_count()

◆ get_command_string()

◆ get_font_name()

◆ get_font_size()

◆ get_plot_count()

◆ get_row_count()

◆ get_terminal()

◆ get_title()

◆ initialize()

◆ is_title_defined()

◆ save_file()

◆ set()

◆ set_font_name()

◆ set_font_size()

◆ set_title()

Member Data Documentation

◆ m_cols

◆ m_hastitle

◆ m_plots

◆ m_rows

◆ m_terminal

◆ m_title