flexiblesusy is hosted by Hepforge, IPPP Durham
FlexibleSUSY

#include <slhaea.h>

Collaboration diagram for SLHAea::Key:
Collaboration graph

Public Member Functions

 Key (const char *keyString)
 Constructs a Key from a string. More...
 
 Key (const Coll::key_type &_block, const Block::key_type &_line, const Line::size_type &_field)
 Constructs a Key from explicit key values. More...
 
 Key (const std::string &keyString)
 Constructs a Key from a string. More...
 
std::string str () const
 Converts a Key into its string representation. More...
 
Keystr (const std::string &keyString)
 Converts a string to a Key. More...
 

Public Attributes

Coll::key_type block
 
Line::size_type field
 
Block::key_type line
 

Detailed Description

Reference to a single field in a SLHA structure. This data type represents a reference to a single field in a SLHA structure, but which is independent of any concrete Coll object. That means that only the keys and the index of the Coll, Block, and Line containers of the corresponding field are stored. One of the main purposes of this data type is the conversion to string and vice versa in a way that the string representation of a Key can be used as a single field in a SLHA structure. For example, the string representation of a Key that refers to the entry in the first row and third column of the RVHMIX matrix is "RVHMIX;1,3;2". Further examples are "1000022;DECAY;2" which refers to the total decay width of the lightest neutralino or "1000022;(any),2,11,24;0" which refers to the branching ratio of the decay of the lightest neutralino into an electron and a W boson.

Definition at line 2432 of file slhaea.h.

Constructor & Destructor Documentation

◆ Key() [1/3]

SLHAea::Key::Key ( const Coll::key_type _block,
const Block::key_type _line,
const Line::size_type _field 
)
inline

Constructs a Key from explicit key values.

Parameters
_blockName of the Block that contains the field.
_lineFirst field(s) of the Line that contains the field.
_fieldIndex of the field in the Line.

Definition at line 2450 of file slhaea.h.

◆ Key() [2/3]

SLHAea::Key::Key ( const std::string &  keyString)
inline

Constructs a Key from a string.

Parameters
keyStringString from which the Key is constructed.
See also
str()

Definition at line 2460 of file slhaea.h.

References str().

◆ Key() [3/3]

SLHAea::Key::Key ( const char *  keyString)
inline

Constructs a Key from a string.

Parameters
keyStringString from which the Key is constructed.
See also
str()

Definition at line 2468 of file slhaea.h.

References str().

Member Function Documentation

◆ str() [1/2]

std::string SLHAea::Key::str ( ) const
inline

Converts a Key into its string representation.

Returns
String that represents the Key.

Definition at line 2498 of file slhaea.h.

References block, field, and line.

Referenced by Key().

◆ str() [2/2]

Key & SLHAea::Key::str ( const std::string &  keyString)
inline

Converts a string to a Key.

Parameters
keyStringString that represents a Key.
Returns
Reference to *this.

Definition at line 2477 of file slhaea.h.

References block, field, and line.

Member Data Documentation

◆ block

Coll::key_type SLHAea::Key::block

Name of the Block that contains the field.

Definition at line 2436 of file slhaea.h.

Referenced by str().

◆ field

Line::size_type SLHAea::Key::field

Index of the field in the Line.

Definition at line 2442 of file slhaea.h.

Referenced by str().

◆ line

Block::key_type SLHAea::Key::line

First field(s) of the Line that contains the field.

Definition at line 2439 of file slhaea.h.

Referenced by str().


The documentation for this struct was generated from the following file: