/farmR/man/FarmRepresentation-class.Rd

https://code.google.com/p/javawfm/ · Unknown · 51 lines · 47 code · 4 blank · 0 comment · 0 complexity · 11a4c6a00ece634aaea24e2d8daa98b6 MD5 · raw file

  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. \title{Class "FarmRepresentation" }
  20. \description{Abstract Class providing generic methods to access properties of Farm objects}
  21. \section{Objects from the Class}{A virtual Class: No objects may be created from it.}
  22. \section{Methods}{
  23. \describe{
  24. \item{cropArea}{\code{signature(farm = "FarmRepresentation", cropName = "character")}: The area in hectares of the named crop. Should only be called on solved farm objects }
  25. \item{cropNames}{\code{signature(object = "FarmRepresentation")}: A string vector with the names of all crops defined for this farm }
  26. \item{eo}{\code{signature(farm = "FarmRepresentation")}: Enterprise output of the farm }
  27. \item{guts}{\code{signature(object = "FarmRepresentation")}: Dump the internal representation of the farm to the screen. This is not pretty }
  28. \item{isSolved}{\code{signature(farm = "FarmRepresentation")}: Returns 1 if the farm has been solved, 0 if not }
  29. \item{model}{\code{signature(farm = "FarmRepresentation")}: Get a reference to the internal java reference representing this farm }
  30. \item{objectiveNames}{\code{signature(object = "FarmRepresentation")}: A string vector with the names of objectives that will be optimised in a call to solvelp }
  31. \item{objectiveScaleFactors}{\code{signature(farm = "FarmRepresentation")}: A numeric vector with the relative weights (normalized) of objectives }
  32. \item{objectiveValues}{\code{signature(farm = "FarmRepresentation")}: Get the values of the objectives. Should only be called for solved farms }
  33. \item{profit}{\code{signature(farm = "FarmRepresentation")}: Get the value of the profit objective }
  34. \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"}) }
  35. \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 }
  36. \item{show}{\code{signature(object = "FarmRepresentation")}: Print a summary of the Farm to the screen }
  37. \item{solvelp}{\code{signature(farm = "FarmRepresentation")}: Solve the Model }
  38. }
  39. }
  40. \author{ Ira Cooke }
  41. \seealso{
  42. See also \code{\linkS4class{Farm}} \code{\linkS4class{CompositeFarm}} and for concrete subclasses
  43. }
  44. \examples{
  45. showClass("FarmRepresentation")
  46. }
  47. \keyword{classes}