Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes

HMMState Class Reference

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

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

List of all members.

Public Member Functions

HMMStateoperator= (const HMMState &)
Constructors and destructors

 HMMState ()
 default constructor
 HMMState (const HMMState &state)
 copy constructor
 HMMState (const String &name, bool hidden=true)
 constructor with name and visibility option
virtual ~HMMState ()
 destructor

void setName (const String &name)
 sets the name of the state
const StringgetName () const
 returns the name of the state
void setHidden (bool hidden)
 sets the hidden property to the state
bool isHidden () const
 returns true if the state is hidden
void addPredecessorState (HMMState *state)
 adds the given predecessor state to the list
void deletePredecessorState (HMMState *state)
 deletes the given predecessor state from the list
void addSuccessorState (HMMState *state)
 add the given successor state to the list
void deleteSuccessorState (HMMState *state)
 deletes the given successor state from the list
const std::set< HMMState * > & getPredecessorStates () const
 returns the predecessor states of the state
const std::set< HMMState * > & getSuccessorStates () const
 return the successor states of the state

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 (  ) 

default constructor

HMMState ( const HMMState state  ) 

copy constructor

HMMState ( const String name,
bool  hidden = true 
)

constructor with name and visibility option

virtual ~HMMState (  )  [virtual]

destructor


Member Function Documentation

void addPredecessorState ( HMMState state  ) 

adds the given predecessor state to the list

void addSuccessorState ( HMMState state  ) 

add the given successor state to the list

void deletePredecessorState ( HMMState state  ) 

deletes the given predecessor state from the list

void deleteSuccessorState ( HMMState state  ) 

deletes the given successor state from the list

const String& getName (  )  const

returns the name of the state

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

returns the predecessor states of the state

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

return the successor states of the state

bool isHidden (  )  const

returns true if the state is hidden

HMMState& operator= ( const HMMState  ) 
void setHidden ( bool  hidden  ) 

sets the hidden property to the state

void setName ( const String name  ) 

sets the name of the state

Accessors


Member Data Documentation

bool hidden_ [protected]
String name_ [protected]
std::set<HMMState *> pre_states_ [protected]
std::set<HMMState *> succ_states_ [protected]

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:49 using doxygen 1.7.1