NxsDistancesBlock Class Reference

This class handles reading and storage for the NEXUS block DISTANCES. More...

#include <nxsdistancesblock.h>

List of all members.

Public Member Functions

 NxsDistancesBlock (NxsTaxaBlockAPI *t)
virtual ~NxsDistancesBlock ()
double GetDistance (unsigned i, unsigned j) const
char GetMissingSymbol () NCL_COULD_BE_CONST
unsigned GetNchar () NCL_COULD_BE_CONST
unsigned GetTriangle () NCL_COULD_BE_CONST
bool IsRectangular () NCL_COULD_BE_CONST
bool IsDiagonal () NCL_COULD_BE_CONST
bool IsInterleave () NCL_COULD_BE_CONST
bool IsLabels () NCL_COULD_BE_CONST
bool IsLowerTriangular () NCL_COULD_BE_CONST
bool IsMissing (unsigned i, unsigned j) const
bool IsUpperTriangular () NCL_COULD_BE_CONST
virtual void Report (std::ostream &out) NCL_COULD_BE_CONST
virtual void Reset ()
void SetDistance (unsigned i, unsigned j, double d)
void SetMissing (unsigned i, unsigned j)
void SetNchar (unsigned i)
void SetNexus (NxsReader *nxsptr)
virtual const std::string & GetBlockName () const
virtual VecBlockPtr GetImpliedBlocks ()
virtual void HandleLinkCommand (NxsToken &token)
virtual void WriteLinkCommand (std::ostream &out) const
void WriteAsNexus (std::ostream &out) const

Protected Member Functions

void HandleDimensionsCommand (NxsToken &token)
void HandleFormatCommand (NxsToken &token)
void HandleMatrixCommand (NxsToken &token)
virtual void Read (NxsToken &token)

Detailed Description

This class handles reading and storage for the NEXUS block DISTANCES.

It overrides the member functions Read and Reset, which are abstract virtual functions in the base class NxsBlock. Below is a table showing the correspondence between the elements of a DISTANCES block and the variables and member functions that can be used to access each piece of information stored. > NEXUS command Command attribute Data Members Member Functions ------------------------------------------------------------------------ DIMENSIONS NEWTAXA newtaxa

NTAX ntax GetNtax

NCHAR nchar GetNchar

FORMAT TRIANGLE triangle GetTriangle IsUpperTriangular IsLowerTriangular IsRectangular

[NO]DIAGONAL diagonal IsDiagonal

[NO]LABELS labels IsLabels

MISSING missing GetMissingSymbol

INTERLEAVE interleave IsInterleave

TAXLABELS (stored in the (access through NxsTaxaBlockAPI data member taxa) object)

MATRIX matrix GetDistance IsMissing SetMissing SetDistance ------------------------------------------------------------------------ >

Definition at line 66 of file nxsdistancesblock.h.

The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Enumerator Friends
Generated on Mon Mar 29 16:37:12 2010 for NCL by  doxygen 1.6.3