stormm::namelist::SceneControls Class Reference

Collect output directives relating to scenes that STORMM might render through a matrix package, MatPlotLib, or PyMol. While the exact contents of the scene to be rendered will be determined by the application and perhaps a particular process within it, the stylistic details will be contained in one of these namelists. The namelist contents will primarily go into a RenderOptions object, but one notable element that the namelist contains is a label that can be used by the calling program to control which of multiple RenderOptions objects the contents should be directed into. More...

#include <nml_scene.h>

Public Member Functions
const std::string &	getLabel () const
	Get the label indicating how this control block is to be connected to program output.
RenderOptions	exportData () const
	Export the relevant information into a RenderOptions object. Rather than individual getters and setters, this object will dump all of its contents at once, into a new RenderOptions object if necessary. The individual getters and setters (with critical validation checks) in that object can then be repurposed to filtering the contents of this object.
void	setLabel (const std::string &label_in)
	Set the label of this object. While it is expected that the label will come through a user input deck, this feature is provided for testing purposes and pairing with the specific getter function.
	SceneControls (ExceptionResponse policy_in=ExceptionResponse::DIE, WrapTextSearch wrap=WrapTextSearch::NO)
	The constructor can prepare an objct with default settings or read the corresponding namelist to accept user input.
	SceneControls (const TextFile &tf, int *start_line, bool *found_nml, ExceptionResponse policy_in=ExceptionResponse::DIE, WrapTextSearch wrap=WrapTextSearch::NO)
	SceneControls (const SceneControls &original)=default
	As with other control objects, copy and move constructors, plus copy and move assignment operators, can all take their default forms.
	SceneControls (SceneControls &&original)=default
SceneControls &	operator= (const SceneControls &original)=default
SceneControls &	operator= (SceneControls &&original)=default

Detailed Description

Collect output directives relating to scenes that STORMM might render through a matrix package, MatPlotLib, or PyMol. While the exact contents of the scene to be rendered will be determined by the application and perhaps a particular process within it, the stylistic details will be contained in one of these namelists. The namelist contents will primarily go into a RenderOptions object, but one notable element that the namelist contains is a label that can be used by the calling program to control which of multiple RenderOptions objects the contents should be directed into.

Constructor & Destructor Documentation

SceneControls()

stormm::namelist::SceneControls::SceneControls	(	ExceptionResponse	policy_in = ExceptionResponse::DIE,
		WrapTextSearch	wrap = WrapTextSearch::NO )

The constructor can prepare an objct with default settings or read the corresponding namelist to accept user input.

Parameters

tf	Input file translated into RAM
start_line	Line of the input file to begin searching for the &minimize namelist
found_nml	Indicator of whether namelist input was found
policy_in	Requested error handling behavior
wrap	Indicate that the search for a &minimize namelist should carry on from the beginning of an input file if no such namelist is found starting from the original starting point

---

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

• src/Namelists/nml_scene.h
• src/Namelists/nml_scene.cpp