From 497f1b516e219d76af82f0b00052ec04b21c76e2 Mon Sep 17 00:00:00 2001 From: MylesScholz Date: Sun, 26 May 2024 13:15:40 -0700 Subject: [PATCH] Documentation updates --- docs/src/cell.md | 2 ++ docs/src/genome.md | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/src/cell.md b/docs/src/cell.md index bbd0a3b..04f6d22 100644 --- a/docs/src/cell.md +++ b/docs/src/cell.md @@ -41,5 +41,7 @@ Description: The Cell object represents a biological cell within a simulation. I - Array getStats(): returns this Cell's statistics as an Array in appropriate units +- Genome *getGenome(): returns a reference to _cellGenome + ## Non-Member Functions None \ No newline at end of file diff --git a/docs/src/genome.md b/docs/src/genome.md index 2e12f01..0309e74 100644 --- a/docs/src/genome.md +++ b/docs/src/genome.md @@ -9,9 +9,29 @@ Inherited by: none Description: the Genome is a class that contains and manages the Cell's Genes ### Properties +- cell_membrane_chance (float[]): the range of values (0 to 100) within which a CellMembraneGene will be created in GenerateRandomGene() +- flagella_chance (float[]): the range of values (0 to 100) within which a FlagellaGene will be created in GenerateRandomGene() +- mitochondria_chance (float[]): the range of values (0 to 100) within which a MitochondriaGene will be created in GenerateRandomGene() +- nucleus_chance (float[]): the range of values (0 to 100) within which a NucleusGene will be created in GenerateRandomGene() +- ribosome_chance (float[]): the range of values (0 to 100) within which a RibosomesGene will be created in GenerateRandomGene() - genes (Vector\): a list of references to Genes managed by this Genome ### Methods +- void setCellMembraneChance(float min, float max): sets cell_membrane_chance to the given values +- float *getCellMembraneChance() const: returns a reference to cell_membrane_chance + +- void setFlagellaChance(float min, float max): sets flagella_chance to the given values +- float *getFlagellaChance() const: returns a reference to flagella_chance + +- void setMitochondriaChance(float min, float max): sets mitochondria_chance to the given values +- float *getMitochondriaChance() const: returns a reference to mitochondria_chance + +- void setNucleusChance(float min, float max): sets nucleus_chance to the given values +- float *getNucleusChance() const: returns a reference to nucleus_chance + +- void setRibosomeChance(float min, float max): sets ribosome_chance to the given values +- float *getRibosomeChance() const: returns a reference to ribosome_chance + - Vector expressGenes(): iterates through genes and creates the list of modified CellStructures defined by it - void addGene(Gene *newGene): appends the given Gene reference to genes @@ -22,5 +42,7 @@ Description: the Genome is a class that contains and manages the Cell's Genes - Gene *getGene(int index): returns the Gene reference at the given index of genes - int getSize(): returns the length of genes +- Gene *GenerateRandomGene(): creates a random Gene based on the chance properties + ## Non-Member Functions None