ModelOptionDef.H File Reference

#include <typeinfo>

Include dependency graph for ModelOptionDef.H:

Go to the source code of this file.

Classes
struct	ModelOptionType
	ModelOptionType -- represents a ModelOptionKind plus type info. More...
struct	ModelOptionCateg
	Holds information about a group of command-line options; used for printing --help message. More...
struct	ModelOptionDef
	Specification of a known model option. More...
Enumerations
enum	ModelOptionKind { MOK_ARG, MOK_FLAG, MOK_OBSOLETE, MOK_ALIAS }
	Model option kinds -- either flag, alias, or argument-requiring option. More...
enum	ModelOptionCategPriority {   MOC_SORTPRI_1, MOC_SORTPRI_2, MOC_SORTPRI_3, MOC_SORTPRI_4,   MOC_SORTPRI_5 }
	Sort-priority levels for ModelOptionCateg (lower number == higher priority). More...
Variables
const ModelOptionCateg	MOC_GENERAL
	General-use options.
const ModelOptionCateg	MOC_ALIAS
	Option aliases.
const int	OPTEXP_NONE = 0
	What to export when calling ModelComponent::exportOptions().
const int	OPTEXP_ALL = 0xffff
	Export all options.
const int	OPTEXP_CORE = (1 << 0)
const int	OPTEXP_SAVE = (1 << 1)
const int	OPTEXP_MRV = (1 << 2)
ModelOptionType initializers
#define	MODOPT_ARG(T)   { MOK_ARG, &(typeid(T)) }
	Builds a ModelOptionType initializer for an option with argument-type T.
const ModelOptionType	MODOPT_FLAG
	ModelOptionType initializer for flag options.
const ModelOptionType	MODOPT_OBSOLETE
	ModelOptionType initializer for obsolete options.
const ModelOptionType	MODOPT_ALIAS
	ModelOptionType initializer for alias options.
const ModelOptionType	MODOPT_ARG_STRING
	ModelOptionType initializer for string options.

---

Detailed Description

Types for defining command-line options.

Definition in file ModelOptionDef.H.

---

Define Documentation

#define MODOPT_ARG

(

T

)

{ MOK_ARG, &(typeid(T)) }

Builds a ModelOptionType initializer for an option with argument-type T.

Definition at line 63 of file ModelOptionDef.H.

---

Enumeration Type Documentation

enum ModelOptionCategPriority

Sort-priority levels for ModelOptionCateg (lower number == higher priority).

Definition at line 81 of file ModelOptionDef.H.

enum ModelOptionKind

Model option kinds -- either flag, alias, or argument-requiring option.

Definition at line 45 of file ModelOptionDef.H.

---

Variable Documentation

const ModelOptionCateg MOC_ALIAS

Option aliases.

Definition at line 59 of file ModelOptionDef.C.

const ModelOptionCateg MOC_GENERAL

General-use options.

Definition at line 58 of file ModelOptionDef.C.

const ModelOptionType MODOPT_ALIAS

ModelOptionType initializer for alias options.

Definition at line 50 of file ModelOptionDef.C.

const ModelOptionType MODOPT_ARG_STRING

ModelOptionType initializer for string options.

Definition at line 54 of file ModelOptionDef.C.

const ModelOptionType MODOPT_FLAG

ModelOptionType initializer for flag options.

Definition at line 42 of file ModelOptionDef.C.

const ModelOptionType MODOPT_OBSOLETE

ModelOptionType initializer for obsolete options.

Definition at line 46 of file ModelOptionDef.C.

const int OPTEXP_ALL = 0xffff

Export all options.

Definition at line 113 of file ModelOptionDef.H.

Referenced by main().

const int OPTEXP_CORE = (1 << 0)

Export our core configuration options that do not require any other model component to be present in the model

Definition at line 117 of file ModelOptionDef.H.

const int OPTEXP_MRV = (1 << 2)

Export options that relate to the MbariResultViewer

Definition at line 124 of file ModelOptionDef.H.

const int OPTEXP_NONE = 0

What to export when calling ModelComponent::exportOptions().

Export no option

Definition at line 110 of file ModelOptionDef.H.

const int OPTEXP_SAVE = (1 << 1)

Export our options that relate to saving results, and require that an OutputFrameSeries be available (and used!) in the model

Definition at line 121 of file ModelOptionDef.H.

Referenced by main().