From 724a793216aee5e0cf69b9213d333b00d22085c9 Mon Sep 17 00:00:00 2001
From: brutzman <brutzman@nps.edu>
Date: Sat, 9 Dec 2023 08:00:54 -0800
Subject: [PATCH] javadoc
---
.../projects/Islas/Client_Customer.java | 12 +++++++-
.../projects/Islas/Client_Farm.java | 2 +-
.../projects/Islas/Customer.java | 10 ++++++-
.../projects/Islas/FarmStore.java | 4 +++
.../projects/Islas/LivestockRanch.java | 30 +++++++++++++------
.../projects/Islas/Server.java | 10 +++++++
6 files changed, 56 insertions(+), 12 deletions(-)
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Customer.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Customer.java
index 30ceb400dd..7dd42e7523 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Customer.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Customer.java
@@ -7,10 +7,20 @@ package MV3500Cohort2023MarchJune.projects.Islas;
import java.io.*;
import java.net.*;
+/** Model */
public class Client_Customer {
+
+ /** Constructor */
+ public Client_Customer()
+ {
+
+ }
+ /** Command line interface
+ * @param args arguments
+ */
public static void main(String[] args) {
- // TODO - Fill out the following questionairre:
+ // TODO - Fill out the following questionnaire:
double averageBeefPurchase = 2; // How many pounds of beef do you typically purchase when you buy groceries?
double averageVariationInBeefPurchase = 0.5; // How much do you typically vary from the above amount (also in pounds)?
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Farm.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Farm.java
index b8830684a8..ca5c74a3b4 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Farm.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Client_Farm.java
@@ -15,7 +15,7 @@ public class Client_Farm {
*/
public static void main(String[] args) {
- // TODO - Fill out the following questionairre:
+ // TODO - Fill out the following questionnaire:
int cattleCount = 50; // How many cows are on the farm?
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Customer.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Customer.java
index 8917091776..18ade37d9a 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Customer.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Customer.java
@@ -16,7 +16,15 @@ public class Customer extends SimEntityBase{
private RandomVariate chickenPreference;
private RandomVariate eggsPreference;
- /** Constructor */
+ /** Constructor
+ * @param averagePurchaseOfBeef initialization value
+ * @param beefPlusMinus initialization value
+ * @param averagePurchaseOfPork initialization value
+ * @param porkPlusMinus initialization value
+ * @param averagePurchaseOfChicken initialization value
+ * @param chickenPlusMinus initialization value
+ * @param averagePurchaseOfEggs initialization value
+ * @param eggsPlusMinus initialization value */
public Customer(double averagePurchaseOfBeef, double beefPlusMinus, double averagePurchaseOfPork, double porkPlusMinus, double averagePurchaseOfChicken, double chickenPlusMinus, double averagePurchaseOfEggs, double eggsPlusMinus) {
this.beefPreference = RandomVariateFactory.getInstance("Normal", averagePurchaseOfBeef, beefPlusMinus);
this.porkPreference = RandomVariateFactory.getInstance("Normal", averagePurchaseOfPork, porkPlusMinus);
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/FarmStore.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/FarmStore.java
index bd4eea96f3..fe6db0618d 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/FarmStore.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/FarmStore.java
@@ -14,9 +14,13 @@ public class FarmStore {
private double CHICKENCOST = 2; // Cost per pound
private double EGGSCOST = 2; // Cost per dozen
+ /** state variable */
protected double beefQuantity; // Quantity in pounds
+ /** state variable */
protected double porkQuantity; // Quantity in pounds
+ /** state variable */
protected double chickenQuantity; // Quantity in pounds
+ /** state variable */
protected double eggQuantity; // Quantity in dozens
/** Constructor */
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/LivestockRanch.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/LivestockRanch.java
index 5da3bf06bf..06339d6cdb 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/LivestockRanch.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/LivestockRanch.java
@@ -16,7 +16,11 @@ public class LivestockRanch {
private double chickenProcessRate;
private double eggLayingRate;
- /** Constructor */
+ /** Constructor
+ * @param totalCattle initialization value
+ * @param totalPigs initialization value
+ * @param totalBroilerChickens initialization value
+ * @param totalLayerChickens initialization value */
public LivestockRanch (int totalCattle, int totalPigs, int totalBroilerChickens, int totalLayerChickens) {
this.totalCattle = totalCattle;
this.totalPigs = totalPigs;
@@ -29,42 +33,50 @@ public class LivestockRanch {
this.eggLayingRate = totalLayerChickens * (25 / 12); // 25 eggs per layer chicken (divided by 12 to be sold in dozens)
}
- /** accessor */
+ /** accessor
+ * @return total number */
public int getTotalCattle() {
return totalCattle;
}
- /** accessor */
+ /** accessor
+ * @return total number */
public int getTotalPigs() {
return totalPigs;
}
- /** accessor */
+ /** accessor
+ * @return total number */
public int getTotalBroilerChickens() {
return totalBroilerChickens;
}
- /** accessor */
+ /** accessor
+ * @return total number */
public int getTotalLayerChickens() {
return totalLayerChickens;
}
- /** Javadoc goes here */
+ /** accessor
+ * @return rate */
public double getCattleProcessRate() {
return cattleProcessRate;
}
- /** accessor */
+ /** accessor
+ * @return rate */
public double getPigProcessRate() {
return pigProcessRate;
}
- /** accessor */
+ /** accessor
+ * @return rate */
public double getChickenProcessRate() {
return chickenProcessRate;
}
- /** accessor */
+ /** accessor
+ * @return rate */
public double getEggLayingRate() {
return eggLayingRate;
}
diff --git a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Server.java b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Server.java
index 5aa492af57..849aef2419 100644
--- a/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Server.java
+++ b/assignments/src/MV3500Cohort2023MarchJune/projects/Islas/Server.java
@@ -7,7 +7,17 @@ package MV3500Cohort2023MarchJune.projects.Islas;
import java.io.*;
import java.net.*;
+/** Model */
public class Server {
+
+ /** Constructor */
+ public Server()
+ {
+
+ }
+ /** Command line interface
+ * @param args arguments
+ */
public static void main(String[] args) {
FarmStore market = new FarmStore();
--
GitLab