repicea.simulation.treelogger

Class WoodPiece

java.lang.Object

repicea.simulation.treelogger.WoodPiece

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BasicTreeLoggerWoodPiece, DiameterBasedWoodPiece

public abstract class WoodPiece
extends java.lang.Object
implements java.io.Serializable

A basic wood piece from a logger. All other pieces class should inherit from this class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WoodPiece.Property

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WoodPiece(LogCategory logCategory, int id, LoggableTree tree, int rank, boolean withBark, boolean withPith) Deprecated.
protected	WoodPiece(LogCategory logCategory, LoggableTree tree, boolean overbark, double volumeOfThisWoodPieceM3) Constructor #2.

Method Summary

Modifier and Type	Method and Description
double	getBarkVolumeM3() This method returns the volume (m3) of this wood piece without any expansion factor.
int	getId() This method returns the identification of this piece.
LogCategory	getLogCategory() This method returns the tree log category associated to this piece.
protected double	getNumberOfStemsExpansionFactor() This method returns the expansion factor for the number of stems.
protected double	getPlotWeightExpansionFactor() This method returns the plot weight expansion factor in the case of unequal sampling probability or unequal areas represented by each plot.
java.lang.Double	getProperty(WoodPiece.Property property) This method returns the value of a given property.
int	getRank() This method return the rank of the log in the tree from the stump to the top.
double	getTotalVolumeM3() This method returns the volume (m3) of this wood piece including the bark without any expansion factor.
LoggableTree	getTreeFromWhichComesThisPiece() This method returns the LoggableTree object from which this piece originates.
double	getWeightedBarkVolumeM3() This method returns the weighted volume of the bark in m3.
double	getWeightedTotalVolumeM3() This method returns the weighted volume of the wood and the bark in m3.
double	getWeightedWoodVolumeM3() This method returns the weighted volume of this WoodPiece instance in m3.
double	getWoodVolumeM3() This method returns the volume (m3) of this wood piece without any expansion factor.
boolean	isWithBark() This method returns true if the piece was calculated with bark or false otherwise.
boolean	isWithPith() This method returns true if the piece was calculated with pith or false otherwise.
void	setProperty(WoodPiece.Property property, java.lang.Double value) This method sets a particular property for this wood piece.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WoodPiece

@Deprecated
protected WoodPiece(LogCategory logCategory,
                                int id,
                                LoggableTree tree,
                                int rank,
                                boolean withBark,
                                boolean withPith)

Deprecated.

Constructor based on the loggable tree. This constructor checks if the tree is a Numberable instance. If so, the number of tree is recorded in the expansionFactor variable.

Parameters:

logCategory - a TreeLogCategory instance

id - an Integer that represents the id of this piece

tree - a LoggableTree instance

rank - an Integer that is the rank of this log in the tree from the stump to the top

withBark - a boolean that indicates whether or not the piece was calculated with bark

withPith - a boolean that indicates whether or not the piece was calculated with pith

WoodPiece

protected WoodPiece(LogCategory logCategory,
                    LoggableTree tree,
                    boolean overbark,
                    double volumeOfThisWoodPieceM3)

Constructor #2.

Parameters:

logCategory - a TreeLogCategory instance

tree - a LoggableTree instance

overbark - a boolean

volumeOfThisWoodPieceM3 - the volume of wood in a single log (NOTE: without any weighting)

Method Detail

getNumberOfStemsExpansionFactor

protected double getNumberOfStemsExpansionFactor()

This method returns the expansion factor for the number of stems. That is the number of stems represented by the LoggableTree instance

Returns:

a double

getPlotWeightExpansionFactor

protected double getPlotWeightExpansionFactor()

This method returns the plot weight expansion factor in the case of unequal sampling probability or unequal areas represented by each plot.

Returns:

a double

getWoodVolumeM3

public double getWoodVolumeM3()

This method returns the volume (m3) of this wood piece without any expansion factor.

Returns:

a double

getBarkVolumeM3

public double getBarkVolumeM3()

This method returns the volume (m3) of this wood piece without any expansion factor.

Returns:

a double

getTotalVolumeM3

public double getTotalVolumeM3()

This method returns the volume (m3) of this wood piece including the bark without any expansion factor.

Returns:

a double

getProperty

public java.lang.Double getProperty(WoodPiece.Property property)

This method returns the value of a given property.

Parameters:

property - the name of the property (String)

Returns:

the value of the property (Double)

setProperty

public void setProperty(WoodPiece.Property property,
                        java.lang.Double value)

This method sets a particular property for this wood piece.

Parameters:

property - a String that is the property name

value - a Double that is the value of the property

getId

public int getId()

This method returns the identification of this piece.

Returns:

an Integer

getLogCategory

public LogCategory getLogCategory()

This method returns the tree log category associated to this piece.

Returns:

a TreeLogCategory instance

getTreeFromWhichComesThisPiece

public LoggableTree getTreeFromWhichComesThisPiece()

This method returns the LoggableTree object from which this piece originates.

Returns:

a LoggableTree instance

getRank

public int getRank()

This method return the rank of the log in the tree from the stump to the top. If the rank has not been defined, it returns -1.

Returns:

an Integer

getWeightedWoodVolumeM3

public double getWeightedWoodVolumeM3()

This method returns the weighted volume of this WoodPiece instance in m3. It should include all expansion factors.

Returns:

the volume in m3 (double)

getWeightedBarkVolumeM3

public double getWeightedBarkVolumeM3()

This method returns the weighted volume of the bark in m3. It should include all expansion factors.

Returns:

the volume in m3 (double)

getWeightedTotalVolumeM3

public double getWeightedTotalVolumeM3()

This method returns the weighted volume of the wood and the bark in m3. It should include all expansion factors.

Returns:

the volume in m3 (double)

isWithBark

public boolean isWithBark()

This method returns true if the piece was calculated with bark or false otherwise.

Returns:

a boolean

isWithPith

public boolean isWithPith()

This method returns true if the piece was calculated with pith or false otherwise.

Returns:

a boolean