bpp::SimpleMafStatisticsResult Class Reference

A simple maf statistics result, with only one value. More...

#include <Bpp/Seq/Io/Maf/MafStatistics.h>

Inheritance diagram for bpp::SimpleMafStatisticsResult:

Collaboration diagram for bpp::SimpleMafStatisticsResult:

Public Member Functions
	SimpleMafStatisticsResult (const std::string &name)
virtual	~SimpleMafStatisticsResult ()
virtual const BppNumberI &	getValue (const std::string &tag) const
virtual const BppNumberI &	getValue () const
virtual void	setValue (const std::string &tag, double value)
	Associate a value to a certain tag. Any existing tag will be overwritten. More...
virtual void	setValue (const std::string &tag, int value)
	Associate a value to a certain tag. Any existing tag will be overwritten. More...
virtual void	setValue (const std::string &tag, unsigned int value)
	Associate a value to a certain tag. Any existing tag will be overwritten. More...
virtual void	setValue (double value)
virtual void	setValue (int value)
virtual void	setValue (unsigned int value)
virtual bool	hasValue (const std::string &tag) const
std::vector< std::string >	getAvailableTags () const

Protected Attributes
std::map< std::string, BppNumberI * >	values_

Private Attributes
std::string	name_

Detailed Description

A simple maf statistics result, with only one value.

Definition at line 145 of file MafStatistics.h.

Constructor & Destructor Documentation

SimpleMafStatisticsResult()

bpp::SimpleMafStatisticsResult::SimpleMafStatisticsResult ( const std::string &  name )

inline

Definition at line 152 of file MafStatistics.h.

References setValue().

~SimpleMafStatisticsResult()

virtual bpp::SimpleMafStatisticsResult::~SimpleMafStatisticsResult ( )

inlinevirtual

Definition at line 155 of file MafStatistics.h.

Member Function Documentation

getAvailableTags()

std::vector<std::string> bpp::MafStatisticsResult::getAvailableTags ( ) const

inlineinherited

Returns

A vector with all available tags.

Definition at line 139 of file MafStatistics.h.

References bpp::MapTools::getKeys(), and bpp::MafStatisticsResult::values_.

Referenced by bpp::AbstractMafStatisticsSimple::getSupportedTags().

getValue() [1/2]

virtual const BppNumberI& bpp::SimpleMafStatisticsResult::getValue ( ) const

inlinevirtual

Definition at line 162 of file MafStatistics.h.

References name_, and bpp::MafStatisticsResult::values_.

getValue() [2/2]

virtual const BppNumberI& bpp::SimpleMafStatisticsResult::getValue ( const std::string &  tag ) const

inlinevirtual

Reimplemented from bpp::MafStatisticsResult.

Definition at line 158 of file MafStatistics.h.

References bpp::MafStatisticsResult::getValue().

hasValue()

virtual bool bpp::MafStatisticsResult::hasValue ( const std::string &  tag ) const

inlinevirtualinherited

Returns

A boolean saying whether a value is available for the given tag.

Parameters

tag	The name of the value to associate.

Definition at line 132 of file MafStatistics.h.

References bpp::MafStatisticsResult::values_.

Referenced by bpp::SequenceStatisticsMafIterator::analyseCurrentBlock_().

setValue() [1/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( const std::string &  tag, double  value  )

inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters

tag	The name of the value to associate.
value	The value to associate to the tag.

Reimplemented from bpp::MafStatisticsResult.

Definition at line 164 of file MafStatistics.h.

References name_.

Referenced by bpp::BlockSizeMafStatistics::compute(), bpp::BlockLengthMafStatistics::compute(), bpp::SequenceLengthMafStatistics::compute(), bpp::AlignmentScoreMafStatistics::compute(), setValue(), and SimpleMafStatisticsResult().

setValue() [2/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( const std::string &  tag, int  value  )

inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters

tag	The name of the value to associate.
value	The value to associate to the tag.

Reimplemented from bpp::MafStatisticsResult.

Definition at line 171 of file MafStatistics.h.

References name_, and setValue().

setValue() [3/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( const std::string &  tag, unsigned int  value  )

inlinevirtual

Associate a value to a certain tag. Any existing tag will be overwritten.

Parameters

tag	The name of the value to associate.
value	The value to associate to the tag.

Reimplemented from bpp::MafStatisticsResult.

Definition at line 178 of file MafStatistics.h.

References name_, and setValue().

setValue() [4/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( double  value )

inlinevirtual

Definition at line 185 of file MafStatistics.h.

References name_, and bpp::MafStatisticsResult::values_.

setValue() [5/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( int  value )

inlinevirtual

Definition at line 190 of file MafStatistics.h.

References name_, and bpp::MafStatisticsResult::values_.

setValue() [6/6]

virtual void bpp::SimpleMafStatisticsResult::setValue ( unsigned int  value )

inlinevirtual

Definition at line 195 of file MafStatistics.h.

References name_, and bpp::MafStatisticsResult::values_.

Member Data Documentation

name_

std::string bpp::SimpleMafStatisticsResult::name_

private

Definition at line 149 of file MafStatistics.h.

Referenced by getValue(), and setValue().

values_

std::map<std::string, BppNumberI*> bpp::MafStatisticsResult::values_

mutableprotectedinherited

Definition at line 65 of file MafStatistics.h.

Referenced by bpp::MafStatisticsResult::getAvailableTags(), getValue(), bpp::MafStatisticsResult::getValue(), bpp::MafStatisticsResult::hasValue(), bpp::MafStatisticsResult::MafStatisticsResult(), bpp::MafStatisticsResult::setValue(), and setValue().

---

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

• Bpp/Seq/Io/Maf/MafStatistics.h