---

datafile.h

Go to the documentation of this file.

// SuperMix version 1.0  C++ source file
//
// Copyright (c) 1999 California Institute of Technology.
// All rights reserved.
//
// Redistribution and use in source and binary forms for noncommercial
// purposes are permitted provided that the above copyright notice and
// this paragraph are duplicated in all such forms and that any
// documentation and other materials related to such distribution and
// use acknowledge that the software was developed by California
// Institute of Technology. Redistribution and/or use in source or
// binary forms is not permitted for any commercial purpose. Use of
// this software does not include a permitted use of the Institute's
// name or trademark for any purpose.
//
// DISCLAIMER:
// THIS SOFTWARE AND/OR RELATED MATERIALS ARE PROVIDED "AS-IS" WITHOUT
// WARRANTY OF ANY KIND INCLUDING ANY WARRANTIES OF PERFORMANCE OR
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE OR PURPOSE (AS SET
// FORTH IN UCC 23212-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE
// LICENSED PRODUCT, HOWEVER USED.  IN NO EVENT SHALL CALTECH/JPL BE
// LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING BUT NOT LIMITED TO
// INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, INCLUDING ECONOMIC
// DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, REGARDLESS OF
// WHETHER CALTECH/JPL SHALL BE ADVISED, HAVE REASON TO KNOW, OR IN
// FACT SHALL KNOW OF THE POSSIBILITY.  THE USER BEARS ALL RISK
// RELATING TO QUALITY AND PERFORMANCE OF THE SOFTWARE AND/OR RELATED
// MATERIALS.
//
/**************************************************************\
*                                                              *
* datafile.h                                                   *
*                                                              *
* J. Zmuidzinas  October 31, 1997                              *
*                                                              *
* datafile.h contains the declaration for the data file class  *
* used by the circuit program. A data file is essentially just *
* a set of columns of floating-point numbers. Comments may be  *
* included - all characters following a ! or # character are   *
* treated as a comment and are thrown away.                    *
*                                                              *
* NOTE THE ORDER IN DATA ACCESS:                               *
*  read(column#, line#)                                        *
*  where column#, row# refer to the position in the file       *
*                                                              *
* Data are stored in the private real_table in this            *
* order; however, the first index of a table is usually called *
* the "row" index and the second index is called the           * 
* "column" index.                                              *
*                                                              *
* 1/19/99:  Fixed the file name arguments (added const)        *
* 2/5/98: Added member fcn table() to allow direct data        *
*         access (FR)                                          *
*                                                              *
\**************************************************************/

#ifndef DATAFILE_H
#define DATAFILE_H 1

#include "table.h"

/**************************************************************\
*                                                              *
* class datafile                                               *
*                                                              *
\**************************************************************/
class datafile
{
private:
  static const unsigned int maxline ; // maximum number of characters per line
  int ncolumns ;               // number of columns in data file
  int nlines ;                 // number of lines
  real_table data ;            // this is where we hold the data

//
// declare a little structure to hold the data temporarily
//
  class tempnumber {
    public:
    int icol ;
    int iline ;
    double value ;
    tempnumber *next ;
  };

public:
  // No default constructor is provided, since the file name must be specified
  datafile(char const * const filename) ;

  // Copy constructor
  datafile(const datafile & df) ;

  // Assignment operator - change to const argument once table is fixed--fixed
  datafile & operator=(const datafile & df);

  // Data retrieval - we can let table class do bounds checking
  double read(int col, int line) const
    { return data.read(col, line); }

  int numcolumns() const {return ncolumns;}
  int numlines() const {return nlines;}

  // Return a pointer to the internal table; to allow copying
  const real_table * table() const {return & data; }

};

#endif /* DATAFILE_H */

---

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by 1.2.7