root/trunk/FRII/cartwheel-interface/ParsedPairwiseAnalysis.hh

/*
 * This file is part of the FamilyRelations II source distribution.
 *
 * FamilyRelations II is part of the FamilyJewels package for comparative
 * sequence analysis: http://family.caltech.edu/.
 *
 * Contact author: C. Titus Brown, titus@caltech.edu.
 *
 * This program and all associated source code files are Copyright (C) 2003,
 * 2004 the California Institute of Technology, Pasadena, CA, 91125 USA.  It
 * is under the Lesser GNU Public License; please see the included
 * LICENSE.txt file for more information, or contact Titus directly.
 *
 */

//
// ParsedPairwiseAnalysis is a virtual base class for a hierarchy of
// that convert between the IFF format (see sister.c++) and the objects
// displayed by the various GUI classes.  It handles features that map
// between two sequences.
//
// The functions supported by all ParsedPairwiseanalysis descendants provide
// a way to get:
//
//    * a list of features, for display between sequence views;
//    * a full-sized control panel.
//
// See ParsedSingleAnalysis for a class for single sequence features.
//

#ifndef PARSED_PAIRWISE_ANALYSIS_HH
#define PARSED_PAIRWISE_ANALYSIS_HH

#include "MappingContainer.hh"

//
// ParsedPairwiseAnalysis
//

class ParsedPairwiseAnalysis {
protected:
  // prevent creation except by inheritance
  ParsedPairwiseAnalysis() { };

  // destructor
  virtual ~ParsedPairwiseAnalysis() { };
public:
  
  // Get a gui::MappingContainer object describing the features in this
  // analysis.
  virtual gui::MappingContainer * get_mapping_container() = 0;

  // Set up a full-sized control panel, suitable for e.g. the FRII
  // pairwise main screen.
  virtual void add_control_panel(Fl_Group *, int&, int&, const int) = 0;
};

#endif // PARSED_PAIRWISE_ANALYSIS_HH