///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015 by Peter Spirtes, Richard Scheines, Joseph   //
// Ramsey, and Clark Glymour.                                                //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program is distributed in the hope that it will be useful,           //
// but WITHOUT ANY WARRANTY; without even the implied warranty of            //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetrad.gene.tetrad.gene.graph;

import edu.cmu.tetrad.util.TetradSerializable;

import java.io.IOException;
import java.io.ObjectInputStream;

/**
 * Stores the parameters needed to generate a new lag graph, whether randomized
 * or manually constructed.
 *
 * @author Joseph Ramsey
 */
public class ManualLagGraphParams implements TetradSerializable {
    static final long serialVersionUID = 23L;

    /**
     * The number of variables per individual.
     *
     * @serial
     */
    private int varsPerInd = 5;

    /**
     * The maximum lag of the lag graph.
     *
     * @serial
     */
    private int mlag = 1;

    //==============================CONSTRUCTORS======================//

    /**
     * Constructs a new parameters object. Must be a blank constructor.
     */
    public ManualLagGraphParams() {
    }

    /**
     * Generates a simple exemplar of this class to test serialization.
     *
     * @see edu.cmu.TestSerialization
     * @see edu.cmu.tetradapp.util.TetradSerializableUtils
     */
    public static ManualLagGraphParams serializableInstance() {
        return new ManualLagGraphParams();
    }

    //=============================PUBLIC METHODS=====================//

    /**
     * Returns the number of variables per individual.
     */
    public int getVarsPerInd() {
        return this.varsPerInd;
    }

    /**
     * Sets the number of variables per individual.
     */
    public void setVarsPerInd(int varsPerInd) {
        if (varsPerInd <= 0) {
            throw new IllegalArgumentException();
        }

        this.varsPerInd = varsPerInd;
    }

    /**
     * Returns the maximum lag.
     */
    public int getMlag() {
        return this.mlag;
    }

    /**
     * Sets the maximum lag.
     */
    public void setMlag(int mlag) {
        if (mlag <= 0) {
            throw new IllegalArgumentException();
        }

        this.mlag = mlag;
    }

    /**
     * Adds semantic checks to the default deserialization method. This method
     * must have the standard signature for a readObject method, and the body of
     * the method must begin with "s.defaultReadObject();". Other than that, any
     * semantic checks can be specified and do not need to stay the same from
     * version to version. A readObject method of this form may be added to any
     * class, even if Tetrad sessions were previously saved out using a version
     * of the class that didn't include it. (That's what the
     * "s.defaultReadObject();" is for. See J. Bloch, Effective Java, for help.
     *
     * @throws java.io.IOException
     * @throws ClassNotFoundException
     */
    private void readObject(ObjectInputStream s)
            throws IOException, ClassNotFoundException {
        s.defaultReadObject();

        if (varsPerInd <= 0) {
            throw new IllegalStateException();
        }

        if (mlag <= 0) {
            throw new IllegalStateException();
        }
    }
}





