/farmR/man/FarmRepresentation-class.Rd

 1\name{FarmRepresentation-class}
 2\Rdversion{1.1}
 3\docType{class}
 4\alias{FarmRepresentation-class}
 5\alias{cropArea,FarmRepresentation,character-method}
 6\alias{cropNames,FarmRepresentation-method}
 7\alias{eo,FarmRepresentation-method}
 8\alias{guts,FarmRepresentation-method}
 9\alias{isSolved,FarmRepresentation-method}
10\alias{model,FarmRepresentation-method}
11\alias{objectiveNames,FarmRepresentation-method}
12\alias{objectiveScaleFactors,FarmRepresentation-method}
13\alias{objectiveValues,FarmRepresentation-method}
14\alias{profit,FarmRepresentation-method}
15\alias{setInputCost,FarmRepresentation,character,numeric-method}
16\alias{constrainArea,FarmRepresentation,character,numeric-method}
17\alias{show,FarmRepresentation-method}
18\alias{solvelp,FarmRepresentation-method}
19
20\title{Class "FarmRepresentation" }
21\description{Abstract Class providing generic methods to access properties of Farm objects}
22\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
23\section{Methods}{
24  \describe{
25    \item{cropArea}{\code{signature(farm = "FarmRepresentation", cropName = "character")}: The area in hectares of the named crop. Should only be called on solved farm objects }
26    \item{cropNames}{\code{signature(object = "FarmRepresentation")}: A string vector with the names of all crops defined for this farm }
27    \item{eo}{\code{signature(farm = "FarmRepresentation")}: Enterprise output of the farm }
28    \item{guts}{\code{signature(object = "FarmRepresentation")}: Dump the internal representation of the farm to the screen. This is not pretty }
29    \item{isSolved}{\code{signature(farm = "FarmRepresentation")}: Returns 1 if the farm has been solved, 0 if not }
30    \item{model}{\code{signature(farm = "FarmRepresentation")}: Get a reference to the internal java reference representing this farm }
31    \item{objectiveNames}{\code{signature(object = "FarmRepresentation")}: A string vector with the names of objectives that will be optimised in a call to solvelp }
32    \item{objectiveScaleFactors}{\code{signature(farm = "FarmRepresentation")}: A numeric vector with the relative weights (normalized) of objectives }
33    \item{objectiveValues}{\code{signature(farm = "FarmRepresentation")}: Get the values of the objectives. Should only be called for solved farms }
34    \item{profit}{\code{signature(farm = "FarmRepresentation")}: Get the value of the profit objective }
35    \item{setInputCost}{\code{signature(farm = "FarmRepresentation", inputName = "character", inputCost = "numeric")}: Set the value of a particular input (potential values are \code{"Input","Machinery","Fuel","Labour","AreaSubsidy"}) }
36
37	\item{constrainArea}{\code{signature(farm = "FarmRepresentation", cropName = "character", lb = "numeric")}: Constrain the area of a particular crop on a farm to be the value \code{lb}. If an optional \code{ub} argument is supplied the constraint is to hold the area of the crop between lb and ub }
38
39    \item{show}{\code{signature(object = "FarmRepresentation")}: Print a summary of the Farm to the screen }
40    \item{solvelp}{\code{signature(farm = "FarmRepresentation")}: Solve the Model }
41	 }
42}
43
44\author{ Ira Cooke }
45\seealso{
46	See also \code{\linkS4class{Farm}} \code{\linkS4class{CompositeFarm}} and for concrete subclasses
47}
48\examples{
49showClass("FarmRepresentation")
50}
51\keyword{classes}