Package pulse.util

Interface Descriptive

All Known Implementing Classes:

AbsoluteDeviations, AbsorptionModel, AbstractData, AbstractIntegrator, AbstractLogger, AbstractResult, Accessible, AdaptiveIntegrator, ADILinearisedSolver, ADIScheme, AdjustableBaseline, AICStatistic, AndersonDarlingTest, AverageResult, Baseline, BeerLambertAbsorption, BFGSOptimiser, BICStatistic, Buffer, ButcherTableau, Calculation, ChandrasekharsQuadrature, ClassicalProblem, ClassicalProblem2D, CompositePathOptimiser, CompositionProduct, CorrelationTest, CoupledImplicitScheme, DiathermicMedium, DiathermicProperties, DifferenceScheme, DiscreteOrdinatesMethod, Discretisation, EmptyCorrelationTest, EmptyTest, ExperimentalData, ExplicitCoupledSolver, ExplicitCoupledSolverNL, ExplicitLinearisedSolver, ExplicitNonlinearSolver, ExplicitRungeKutta, ExplicitScheme, ExplicitTranslucentSolver, ExponentiallyModifiedGaussian, ExtendedThermalProperties, FixedIntervalIntegrator, FixedIterations, FlatBaseline, Gas, GeneralTask, GoldenSectionOptimiser, GradientBasedOptimiser, GraphicalLogPane, Grid, Grid2D, Group, Harmonic, HeatingCurve, Helium, ImplicitCoupledSolver, ImplicitCoupledSolverNL, ImplicitDiathermicSolver, ImplicitLinearisedSolver, ImplicitNonlinearSolver, ImplicitScheme, ImplicitTranslucentSolver, ImplicitTwoTemperatureSolver, Insulator, IterativeSolver, KSTest, LinearBaseline, LinearOptimiser, LMOptimiser, Log, Metadata, MidpointIntegrator, MixedCoupledSolver, MixedCoupledSolverNL, MixedLinearisedSolver, MixedScheme, ModelSelectionCriterion, NewtonCotesQuadrature, Nitrogen, NonlinearProblem, NonscatteringAnalyticalDerivatives, NonscatteringDiscreteDerivatives, NonscatteringRadiativeTransfer, NormalityTest, NumericPulse, NumericPulseData, ODEIntegrator, OneDimensionalScheme, OptimisablePolyline, OptimiserStatistic, OrdinateSet, ParticipatingMedium, ParticleSwarmOptimiser, PathOptimiser, PearsonCorrelation, PenetrationProblem, PolylineOptimiser, Problem, PropertyHolder, Pulse, Pulse2D, PulseTemporalShape, RadiativeTransferCoupling, RadiativeTransferSolver, Range, RangePenalisedLeastSquares, RectangularPulse, RegularisedLeastSquares, ResidualStatistic, Result, ResultTable, RSquaredTest, SearchTask, SimpleOptimisationTask, SimpsonIntegrator, SinusoidalBaseline, SpearmansCorrelationTest, SR1Optimiser, Statistic, SteepestDescentOptimiser, StretchedGrid, SuccessiveOverrelaxation, SumOfSquares, TaskManager, TextLogPane, ThermalProperties, ThermoOpticalProperties, TrapezoidalPulse, TRBDF2, TwoTemperatureModel, TwoTemperatureProperties, UpwardsNavigable, WolfeOptimiser

public interface Descriptive

Provides the describe() functionality.

See Also:

Exporter

Method Summary

Modifier and Type	Method	Description
default String	describe()	Creates a String 'describing' this object, usually for exporting purposes.

Method Detail

describe

default String describe()

Creates a String 'describing' this object, usually for exporting purposes.

Returns:

by default, this will return the name of the implementing class and the date of the calculation.