Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
MylesScholz committed May 26, 2024
1 parent e9ed005 commit 497f1b5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
22 changes: 22 additions & 0 deletions docs/src/genome.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\<Gene *\>): 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<CellStructure *> 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
Expand All @@ -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

0 comments on commit 497f1b5

Please sign in to comment.