gmx::AnalysisDataPlotSettings Class Reference

#include <gromacs/analysisdata/modules/plot.h>

Description

Common settings for data plots.

Public Member Functions
	AnalysisDataPlotSettings ()
	Constructs default analysis plot settings.
const SelectionCollection *	selectionCollection () const
	Returns the selection collection set with setSelectionCollection().
TimeUnit	timeUnit () const
	Returns the time unit set with setTimeUnit().
XvgFormat	plotFormat () const
	Returns the plot format.
void	setSelectionCollection (const SelectionCollection *selections)
	Set selection collection to print as comments into the output. More...
void	setTimeUnit (TimeUnit timeUnit)
	Sets the time unit for the plot. More...
void	initOptions (IOptionsContainer *options)
	Adds common options for setting plot options. More...

Member Function Documentation

void gmx::AnalysisDataPlotSettings::initOptions

(

IOptionsContainer *

options

)

Adds common options for setting plot options.

Parameters

[in,out]

options

Options object to which options are added.

void gmx::AnalysisDataPlotSettings::setSelectionCollection

(

const SelectionCollection *

selections

)

Set selection collection to print as comments into the output.

Formatted selection text from all selections in selections is printed as comments in the output file. If this method is not called, no selection information is written to the output.

void gmx::AnalysisDataPlotSettings::setTimeUnit ( TimeUnit  timeUnit )

inline

Sets the time unit for the plot.

The value is used only if AbstractPlotModule::setXAxisIsTime() is called, in which case it is used to print the appropriate axis label and to scale the values. If not called, the default time unit is ps.

---

The documentation for this class was generated from the following files:

• api/legacy/include/gromacs/analysisdata/modules/plot.h
• src/gromacs/analysisdata/modules/plot.cpp