repicea.simulation.covariateproviders.plotlevel.DrainageGroupProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of repicea-simulation Show documentation

Simulation methods

There is a newer version: 1.3.2

/*
 * This file is part of the repicea-simulation library.
 *
 * Copyright (C) 2009-2020 Mathieu Fortin for Rouge-Epicea
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed with 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 Lesser General Public
 * License for more details.
 *
 * Please see the license at http://www.gnu.org/copyleft/lesser.html.
 */
package repicea.simulation.covariateproviders.plotlevel;

import repicea.math.Matrix;

/**
 * This interface ensures that the stand object can provide its
 * drainage group: xeric, mesic, subhydric or hydric.
 * @author Mathieu Fortin - November 2012 (refactored June 2020)
 * 		
 */
public interface DrainageGroupProvider {

	public static enum DrainageGroup {
		Xeric,
		Mesic,
		Subhydric,
		Hydric;

		private final Matrix dummy;
		
		DrainageGroup() {
			dummy = new Matrix(1,4);
			dummy.setValueAt(0, ordinal(), 1d);
		}

		public Matrix getDrainageDummy() {return dummy;}

	}
	
	
	/**
	 * This method returns the drainage group: xeric, mesic, subhydric or hydric.
	 * @return a DrainageCategoryProvider enum 
	 */
	public DrainageGroup getDrainageGroup();

}