org.anchoranalysis.mpp.feature.bean.mark

Class CheckMark

Object

AnchorBean<B>

InitializableBean<T,MarksInitialization>

MarksBean<CheckMark>

CheckMark

All Implemented Interfaces:

CompatibleWithMark

Direct Known Subclasses:

AndList, CheckMarkWithMask, FeatureValueCheckMark, Not, RadiiMinRatio, VolumeMin

public abstract class CheckMark
extends MarksBean<CheckMark>
implements CompatibleWithMark

A predicate on a mark to check if a condition has been satisfied.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor and Description
CheckMark()

Method Summary

Modifier and Type	Method and Description
abstract boolean	check(Mark mark, RegionMap regionMap, EnergyStack energyStack) Checks a mark
void	end() Called after any calls to check(org.anchoranalysis.mpp.mark.Mark, org.anchoranalysis.mpp.bean.regionmap.RegionMap, org.anchoranalysis.feature.energy.EnergyStack)
void	start(EnergyStack energyStack) Called before any calls to check(org.anchoranalysis.mpp.mark.Mark, org.anchoranalysis.mpp.bean.regionmap.RegionMap, org.anchoranalysis.feature.energy.EnergyStack)

Methods inherited from class MarksBean

initializerForMarksBeans

Methods inherited from class InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

Methods inherited from class AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class Object

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

Methods inherited from interface CompatibleWithMark

isCompatibleWith

Constructor Detail

CheckMark

public CheckMark()

Method Detail

start

public void start(EnergyStack energyStack)
           throws OperationFailedException

Called before any calls to check(org.anchoranalysis.mpp.mark.Mark, org.anchoranalysis.mpp.bean.regionmap.RegionMap, org.anchoranalysis.feature.energy.EnergyStack)

Parameters:

energyStack -

Throws:

OperationFailedException

check

public abstract boolean check(Mark mark,
                              RegionMap regionMap,
                              EnergyStack energyStack)
                       throws CheckException

Checks a mark

Parameters:

mark - the mark to check

regionMap - the region-map

energyStack - the corresponding energy-stack for the mark

Returns:

true if the mark satisfies the check, false otherwise

Throws:

CheckException

end

public void end()

Called after any calls to check(org.anchoranalysis.mpp.mark.Mark, org.anchoranalysis.mpp.bean.regionmap.RegionMap, org.anchoranalysis.feature.energy.EnergyStack)