Package school

Interface Summary
Convert Interface to be implemented if a class is to be able to convert from xml to gnuplot format for 3D data
Probe Interface to be implemented by a class which samples a defined 3D surface
RandomGen Interface to be implemented by a class which generates a set of random Points within a specified 2D square.
Render Interface to be implemented if a class is to be able to visualise a sampled surface.
Sequence Interface to be implemented by an object which generates a 1D sequence of equally spaced real numbers.
Storage Interface to be implemented by an object capable of storing and retrieving data from files and managing the files.
XProduct Interface to define the function taking the cross product of two 1D files and outputting to a 2D file.
 

Class Summary
Box Class defining a square with sides parallel to the x and y axes.
FileName Defines a class holding the name of a file containing 1D, 2D or 3D data The file name must be approriate for a Unix file system.
FileName1D A class holding the name of a file containing 1D data (a set of real numbers) specified by OneDFile.
FileName2D A class holding the name of a file containing 2D data (pairs of 2D points) specified by TwoDFile.
FileName3D A class holding the name of a file containing 3D data (samples of a surface) specified by ThreeDFile.
FileStore Class capable of storing and retrieving data from files and managing the files.
OneDFile Class for holding and manipulating 1D data
Point Class to hold and manipulate a 2D point (a pair of real numbers (x,y))
RandGen A class which generates a set of random points (x,y) within a specified 2D square.
Reformat Converts 3D files from XML to a format acceptable to GnuPlot
SeqGen Class for generating a 1D sequence of equally spaced real numbers.
Surface1 Class for sampling a 3D defined surface, where the samples are taken at specified 2D coordinates.
ThreeDFile Class for holding and manipulating 3D data (x,y,h)
Triple Class representing 3D data defining a point on a surface.
TwoDFile Class for holding and manipulating 2D data
Visualiser Class for visualising the sampled surface using GnuPlot
XProdGen Class for taking the cross product of two sets of 1D data.
 

Exception Summary
BoxException Exception thrown if a Box instance is not valid or a (x,y) point is outside of the Box.
FileNameException Exception thrown when there is an error forming a FileName instance
FileStoreException Exception thrown if an error occurs while using a FileStore instance
GeneratorException Exception thrown when an error occurs during the RandGen, XProdGen or SeqGen generate methods.
ProbeException Exception thrown when an error occurs in an instance of Surface
ReformatException Exception thrown if an instance of Point is not within a specified range.
RenderException Exception thrown if an error occurs while visualising a 3D surface.