SLHAea  0.1
containers for SUSY Les Houches Accord input/output
 All Classes Namespaces Files Functions Variables Typedefs
Public Member Functions | Public Attributes | List of all members
Key Struct Reference

Reference to a single field in a SLHA structure. More...

#include <slhaea.h>

Public Member Functions

 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...
 
 Key (const char *keyString)
 Constructs a Key from a string. More...
 
Keystr (const std::string &keyString)
 Converts a string to a Key. More...
 
std::string str () const
 Converts a Key into its string representation. More...
 

Public Attributes

Coll::key_type block
 Name of the Block that contains the field. More...
 
Block::key_type line
 First field(s) of the Line that contains the field. More...
 
Line::size_type field
 Index of the field in the Line. More...
 

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.

Constructor & Destructor Documentation

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.
Key ( const std::string &  keyString)
inline

Constructs a Key from a string.

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

+ Here is the call graph for this function:

Key ( const char *  keyString)
inline

Constructs a Key from a string.

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

+ Here is the call graph for this function:

Member Function Documentation

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

Converts a string to a Key.

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

+ Here is the caller graph for this function:

std::string str ( ) const
inline

Converts a Key into its string representation.

Returns
String that represents the Key.

+ Here is the caller graph for this function:

Member Data Documentation

Name of the Block that contains the field.

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

Index of the field in the Line.


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