gmx::SelectionParserSymbol Class Reference

#include <gromacs/selection/symrec.h>

Description

Single symbol for the selection parser.

Public methods in this class do not throw.

Classes
class	Impl
	Private implementation class for SelectionParserSymbol. More...

Public Types
enum	SymbolType { ReservedSymbol, VariableSymbol, MethodSymbol, PositionSymbol }
	Defines the type of the symbol. More...

Public Member Functions
const std::string &	name () const
	Returns the name of the symbol.
SymbolType	type () const
	Returns the type of the symbol.
gmx_ana_selmethod_t *	methodValue () const
	Returns the method associated with a MethodSymbol symbol. More...
const SelectionTreeElementPointer &	variableValue () const
	Returns the selection tree associated with a VariableSymbol symbol. More...

Friends
class	SelectionParserSymbolTable
	Needed to call the constructor and for other initialization.

Member Enumeration Documentation

enum gmx::SelectionParserSymbol::SymbolType

Defines the type of the symbol.

Enumerator
ReservedSymbol	The symbol is a reserved keyword.
VariableSymbol	The symbol is a variable.
MethodSymbol	The symbol is a selection method.
PositionSymbol	The symbol is a position keyword.

Member Function Documentation

gmx_ana_selmethod_t * gmx::SelectionParserSymbol::methodValue

(

)

const

Returns the method associated with a MethodSymbol symbol.

Returns

The method associated with the symbol.

Must only be called if type() returns MethodSymbol.

const gmx::SelectionTreeElementPointer & gmx::SelectionParserSymbol::variableValue

(

)

const

Returns the selection tree associated with a VariableSymbol symbol.

Returns

The variable expression associated with the symbol.

Must only be called if type() returns VariableSymbol.

---

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

• src/gromacs/selection/symrec.h
• src/gromacs/selection/symrec.cpp