Interface for species classes, stating the methods that these classes should include. More...

Inheritance diagram for simulator.agent.HasSpecies:

Public Member Functions
void	createNewAgent () throws CloneNotSupportedException
	Create a new progenitor with random deviation of the parameters. More...

HasSpecies	sendNewAgent () throws CloneNotSupportedException
	Obtain another instance of the same species (totally independent). The returned agent is NOT registered. More...

void	setSpecies (Species aSpecies)
	Set the species to a specified Species object. More...

String	sendHeader ()
	Used in creation of results files - specifies the header of the columns of output information for this agent. More...

SpeciesParam	getSpeciesParam ()
	Return the set of parameters that is associated with the object of this species. More...

void	mutatePop ()
	Mutates inherited parameters and distributes particle mass - either exponentially or normally, dependent on value of distMethod. More...

Detailed Description

Interface for species classes, stating the methods that these classes should include.

Interface for species classes, stating the methods that these classes should include

Member Function Documentation

void simulator.agent.HasSpecies.createNewAgent ( ) throws CloneNotSupportedException

Create a new progenitor with random deviation of the parameters.

Create a new progenitor with random deviation of the parameters

Exceptions

CloneNotSupportedException Exception thrown if the object cannot be cloned

SpeciesParam simulator.agent.HasSpecies.getSpeciesParam ( )

Return the set of parameters that is associated with the object of this species.

Return the set of parameters that is associated with the object of this species

Returns: Object of BacteriumParam that stores the parameters associated with this species

void simulator.agent.HasSpecies.mutatePop ( )

Mutates inherited parameters and distributes particle mass - either exponentially or normally, dependent on value of distMethod.

Mutates inherited parameters and distributes particle mass - either exponentially or normally, dependent on value of distMethod

String simulator.agent.HasSpecies.sendHeader ( )

Used in creation of results files - specifies the header of the columns of output information for this agent.

Used in creation of results files - specifies the header of the columns of output information for this agent

Returns: String specifying the header of each column of results associated with this agent

HasSpecies simulator.agent.HasSpecies.sendNewAgent ( ) throws CloneNotSupportedException

Obtain another instance of the same species (totally independent). The returned agent is NOT registered.

Obtain another instance of the same species (totally independent). The returned agent is NOT registered

Exceptions

CloneNotSupportedException Exception thrown if the object cannot be cloned

void simulator.agent.HasSpecies.setSpecies ( Species aSpecies )

Set the species to a specified Species object.

Set the species parameters to a specified Species object

Parameters

aSpecies Species object to set this Species object to

The documentation for this interface was generated from the following file: