hops::MHO_ControlDefinitions Class Reference

Class MHO_ControlDefinitions. More...

#include <MHO_ControlDefinitions.hh>

Public Member Functions
	MHO_ControlDefinitions ()
virtual	~MHO_ControlDefinitions ()

Static Public Member Functions
static std::string	CommentFlag ()
	Returns a string containing an asterisk (*). More...
static control_element_type	DetermineControlType (std::string etype)
	Determines control type based on input string type. More...
static mho_json	GetControlFormat ()
	Getter for composite/complete control format as a json object. More...
static std::string	GetFormatDirectory ()
	Getter for the control (json) format directory. More...
static std::vector< std::string >	GetKeywordNames ()
	Getter for control keyword names. More...
static std::string	WhitespaceDelim ()
	Returns a string containing whitespace characters. More...

Detailed Description

Class MHO_ControlDefinitions.

Constructor & Destructor Documentation

MHO_ControlDefinitions()

hops::MHO_ControlDefinitions::MHO_ControlDefinitions ( )

inline

~MHO_ControlDefinitions()

virtual hops::MHO_ControlDefinitions::~MHO_ControlDefinitions ( )

inlinevirtual

Member Function Documentation

CommentFlag()

static std::string hops::MHO_ControlDefinitions::CommentFlag ( )

inlinestatic

Returns a string containing an asterisk (*).

Returns

A string containing an asterisk (*)

Note

This is a static function.

DetermineControlType()

control_element_type hops::MHO_ControlDefinitions::DetermineControlType ( std::string  etype )

static

Determines control type based on input string type.

Parameters

etype

Input string representing control element type.

Returns

control_element_type corresponding to input string.

Note

This is a static function.

GetControlFormat()

mho_json hops::MHO_ControlDefinitions::GetControlFormat ( )

static

Getter for composite/complete control format as a json object.

Returns

mho_json object containing all element formats keyed by keyword names

Note

This is a static function.

GetFormatDirectory()

std::string hops::MHO_ControlDefinitions::GetFormatDirectory ( )

static

Getter for the control (json) format directory.

Returns

std::string representing the format directory.

Note

This is a static function.

GetKeywordNames()

std::vector< std::string > hops::MHO_ControlDefinitions::GetKeywordNames ( )

static

Getter for control keyword names.

Returns

Vector of string keyword names

Note

This is a static function.

WhitespaceDelim()

static std::string hops::MHO_ControlDefinitions::WhitespaceDelim ( )

inlinestatic

Returns a string containing whitespace characters.

Returns

A std::string containing whitespace characters (space, tab, carriage return, and newline).

Note

This is a static function.

---

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

• MHO_ControlDefinitions.hh
• MHO_ControlDefinitions.cc