| OpenMS 2.5.0

Public Member Functions | Protected Attributes | List of all members
HMMState Class Reference

Hidden Markov Model State class for the Hidden Markov Model. More...

`#include <OpenMS/ANALYSIS/ID/HiddenMarkovModel.h>`

## Public Member Functions

HMMState & | operator= (const HMMState &)
Constructors and destructors
| HMMState ()
| default constructor More...
| HMMState (const HMMState &state)
| copy constructor More...
| HMMState (const String &name, bool hidden=true)
| constructor with name and visibility option More...
virtual | ~HMMState ()
| destructor More...
void | setName (const String &name)
| sets the name of the state More...
const String & | getName () const
| returns the name of the state More...
void | setHidden (bool hidden)
| sets the hidden property to the state More...
bool | isHidden () const
| returns true if the state is hidden More...
void | addPredecessorState (HMMState *state)
| adds the given predecessor state to the list More...
void | deletePredecessorState (HMMState *state)
| deletes the given predecessor state from the list More...
void | addSuccessorState (HMMState *state)
| add the given successor state to the list More...
void | deleteSuccessorState (HMMState *state)
| deletes the given successor state from the list More...
const std::set< HMMState * > & | getPredecessorStates () const
| returns the predecessor states of the state More...
const std::set< HMMState * > & | getSuccessorStates () const
| return the successor states of the state More...

## Protected Attributes

bool | hidden_
String | name_
std::set< HMMState * > | pre_states_
std::set< HMMState * > | succ_states_

## Detailed Description

Hidden Markov Model State class for the Hidden Markov Model.

## Constructor & Destructor Documentation

## ◆ HMMState() [1/3]

HMMState | ( |  | ) |

default constructor

## ◆ HMMState() [2/3]

HMMState | ( | const HMMState & | state | ) |

copy constructor

## ◆ HMMState() [3/3]

HMMState | ( | const String & | name,
|  | bool | hidden = `true`
| ) |  |

constructor with name and visibility option

## ◆ ~HMMState()

virtual ~HMMState | ( |  | ) |

virtual

destructor

## Member Function Documentation

## ◆ addPredecessorState()

void addPredecessorState | ( | HMMState * | state | ) |

adds the given predecessor state to the list

## ◆ addSuccessorState()

void addSuccessorState | ( | HMMState * | state | ) |

add the given successor state to the list

## ◆ deletePredecessorState()

void deletePredecessorState | ( | HMMState * | state | ) |

deletes the given predecessor state from the list

## ◆ deleteSuccessorState()

void deleteSuccessorState | ( | HMMState * | state | ) |

deletes the given successor state from the list

## ◆ getName()

const String& getName | ( |  | ) | const

returns the name of the state

## ◆ getPredecessorStates()

const std::set<HMMState *>& getPredecessorStates | ( |  | ) | const

returns the predecessor states of the state

## ◆ getSuccessorStates()

const std::set<HMMState *>& getSuccessorStates | ( |  | ) | const

return the successor states of the state

## ◆ isHidden()

bool isHidden | ( |  | ) | const

returns true if the state is hidden

## ◆ operator=()

HMMState& operator= | ( | const HMMState & |  | ) |

## ◆ setHidden()

void setHidden | ( | bool | hidden | ) |

sets the hidden property to the state

## ◆ setName()

void setName | ( | const String & | name | ) |

sets the name of the state

Accessors

## Member Data Documentation

## ◆ hidden_

bool hidden_

protected

## ◆ name_

String name_

protected

## ◆ pre_states_

std::set<HMMState *> pre_states_

protected

## ◆ succ_states_

std::set<HMMState *> succ_states_

protected