Package nz.org.riskscape.engine.function.geometry

Class SampleCoverageOne

java.lang.Object
nz.org.riskscape.engine.function.geometry.SampleCoverageOne
All Implemented Interfaces:
AutoCloseable, nz.org.riskscape.engine.function.RiskscapeFunction, nz.org.riskscape.engine.function.UntypedFunction, nz.org.riskscape.engine.rl.RealizableFunction
public class SampleCoverageOne extends Object implements nz.org.riskscape.engine.function.RiskscapeFunction, nz.org.riskscape.engine.rl.RealizableFunction

Sample function that will return a single sample or null. Sampling if first performed at the centroid, if no sample is found at the centroid then the closest (to the centroid) all intersections match is chosen. Note that the centroid is only sampled if the centroid is contained by the geometry

  • Nested Class Summary

    Nested classes/interfaces inherited from interface nz.org.riskscape.engine.rl.RealizableFunction

    nz.org.riskscape.engine.rl.RealizableFunction.MetadataIdentifiedRealizableFunction

  • Field Summary

    Fields inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

    BUILT_IN

  • Constructor Summary

    Constructors
    Constructor
    Description
    SampleCoverageOne()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    call(List<Object> args)
     
    nz.org.riskscape.engine.function.ArgumentList
    getArguments()
     
    List<nz.org.riskscape.engine.types.Type>
    getArgumentTypes()
     
    nz.org.riskscape.engine.types.Type
    getReturnType()
     
    nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.RiskscapeFunction>
    realize(nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.rl.ast.FunctionCall functionCall, List<nz.org.riskscape.engine.types.Type> realizeTypes)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

    builtin, getAggregationFunction, getOverloaded, getRealizable, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

    Methods inherited from interface nz.org.riskscape.engine.function.UntypedFunction

    close

  • Constructor Details

    • SampleCoverageOne

      public SampleCoverageOne()

  • Method Details

    • getArgumentTypes

      public List<nz.org.riskscape.engine.types.Type> getArgumentTypes()
      Specified by:
      getArgumentTypes in interface nz.org.riskscape.engine.function.RiskscapeFunction

    • call

      public Object call(List<Object> args)
      Specified by:
      call in interface nz.org.riskscape.engine.function.UntypedFunction

    • getReturnType

      public nz.org.riskscape.engine.types.Type getReturnType()
      Specified by:
      getReturnType in interface nz.org.riskscape.engine.function.RiskscapeFunction

    • realize

      public nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.RiskscapeFunction> realize(nz.org.riskscape.engine.rl.RealizationContext context, nz.org.riskscape.rl.ast.FunctionCall functionCall, List<nz.org.riskscape.engine.types.Type> realizeTypes)
      Specified by:
      realize in interface nz.org.riskscape.engine.rl.RealizableFunction

    • getArguments

      public nz.org.riskscape.engine.function.ArgumentList getArguments()
      Specified by:
      getArguments in interface nz.org.riskscape.engine.function.RiskscapeFunction