Skip to content

Latest commit

 

History

History
302 lines (219 loc) · 8.81 KB

Documentation.md

File metadata and controls

302 lines (219 loc) · 8.81 KB
Raw

Documentation of the UML Model

Full definitions of all of the elements in the UML Model are provided here with Classes in alphabetical order. However, the definitive Model is in the PlantUML files (see here).

Application

Application of a substance in an operation.

Property
Quantity : number Quantity of substance applied, in kilogrammes for solids, or litres for liquids (and possibly gases).

Association class for Operation applies Substance

Batch

A batch of produce of a crop.

Property
Reference : text A reference for the batch.
Associations
Harvest Any number of Harvests may be delivered into a batch.
Planting from Batch Any number of Plantings may be made from a batch.
Batch of Produce Any number of Batches may be of a Produce.
Processing of Batch Any number of processings may be made of a batch.
Purchase into Batch Any number of purchases may be made into a batch.
Sale from Batch Any number of sales may be made from a batch
Test on Batch Any number of tests may be made on a batch
Transfer from Batch Any number of transfers may be made from a batch.
Transfer to Batch Any number of transfers may be made to a batch.

Crop

A community of cultivated plants.

Associations
Planting A crop has at least one planting.
Row A crop may have an ordered pattern of rows (if it is not broadcast).

Harvest

Harvest of produce from a location.

Properties
DateTime : datetime Date and time of the harvest.
Quantity : number Quantity of crop harvested in kilogrammes.

Associated with

Ingredient

An ingredient of a substance.

Properties
Name : enumeration One of an agreed list of names for ingredients of substances used in crop production.
Concentration : number Percentage concentration of the ingredient in the substance.

Aggregated by

Location

A location on the Earth's surface with some relation to crop production.

Specializations

Associations
Harvest at Location Any number of harvests can be made at a location.
Observation at Location Any number of observations can be made at a location.
Operation at Location Any number of operations can be carried out at a location.
Planting at Location Any number of plantings/sowings can be made at a location.
Location contains Location A Location may contain (include) any number of other locations.

Observation

An observation at a location related to crop production.

Property
DateTime : datetime Date and time of the observation.

Associated with

Operation

An operation at a location related to crop production.

Property
DateTime : datetime Date and time that the operation was carried out.
Association
Operation applies Substance An Operation may apply any number of different substances.

Associated with -Location

Path

A mapped path on the Earth's surface with some relation to crop production.

Method
Aggregation
Path has Point A Path has an ordered set of at least two waypoints, represented as Points.

Generalization

Planting

Planting/sowing of a crop

Properties
DateTime : datetime Date and time of the planting/sowing.
Quantity : number Quantity of material planted/sown in kilogrammes.
Broadcast : boolean True if the planting was random, or the sowing was broadcast.

Associated with

Point

A point, with some relvance to crop production in a rectangle representing an Equirectangular projection of the Earth's surface.

Properties
Latitude : number the latitude of the Point expressed in decimal degrees to a precision of no more than 7 decimal places.
Longitude : number the longitude of the Point expressed in decimal degrees to a precision of no more than 7 decimal places.

Aggregated by

Generalization

Polygon

A non-self-intersecting polygon on the Earth's surface with some relation to crop production.

Aggregation
Polygon has Point A polygon has an ordered set of at least three Vertices, represented as Points, such that no straight line between any two consecutive points is allowed to cross any other straight line between two consecutive points or between the first point and the last point.

Member of

Aggregated by

Processing

Some processing of a batch of produce.

Property
DateTime : datetime Date and time of the processing.

Associated with

Produce

Description of plant material harvested for some use.

Properties
Species : enumeration The species of the plants.
Variety : enumeration The variety (cultivar) of the plants.
Part : enumeration The part of the plants (e.g. grain, or straw).

Associated with

Purchase

A purchase of produce (possibly as seed), or other movement of produce to a Batch which is not from another Batch.

Properties
DateTime : datetime Date and time of movement of the produce to the Batch.
Quantity : number Quantity of produced moved in kilogrammes.

Associated with

Region

A mapped region of the Earth's surface with some relation to crop production which may consist of any number of non-contiguous parts.

Aggregation
Region has RegionPart A Region must have at least one RegionPart.

Generalization

RegionPart

A part of a Region.

Property
ExternalBoundary : Polygon The external boundary of the part of the region.
Aggregation
Polygon excludes land from RegionPart Any number of Holes, represented as Polygons, may exclude land from a RegionPart.

Row

Row of crop within a pattern

Property
Distance : number Distance in centimetres to the next row in the pattern.
Association
Planting A row is from a planting which must be one of the plantings of the crop of which it is a row

Associated with

Sale

A sale of produce , or other movement of produce from a Batch which is not to another Batch.

Properties
DateTime : datetime Date and time of movement of the produce from the Batch.
Quantity : number Quantity of produced moved in kilogrammes.

Associated with

Substance

A substance used in crop production.

Property
Name : enumeration One of an agreed list of names for substances used in crop production.
State : enumeration Physical state in which the substance is used.
Aggregation
Ingredient in Substance A substance may contain a number of ingredients.

Test

A test on a batch of produce.

Property
DateTime : datetime Date and time of the sampling for the test.

Associated with

Transfer

Transfer of produce from one batch to another.

Properties
DateTime : datetime Date and time of the transfer.
Quantity : number Quantity transferred in kilogrammes.

Associated with

UnmappedPath

An unmapped path on the Earth's surface with some relation to crop production.

Property
Length : number Length of the unmapped path in metres.

Generalization

UnmappedPoint

An unmapped point having some relevance to crop production.

Generalization

UnmappedRegion

An unmapped region of the Earth's surface with some relation to crop production which may consist of any number of non-contiguous parts.

Property
Area : number Area of the unmapped region in hectares.

Generalization