RandomMove¶
This page describes the class RandomMove
The class RandomMove
is derived from Action
lets agents move in random directions.
This class can be used for simulationg diffusion.
- Code:
Attributes:
|
“RandomMove” |
action name |
|
“RandomMove_prob” |
move probability |
Public Methods¶
constructors
¶
RandomMove(SPopulation<T> *pPop, SCellGrid *pCG, const std::string sActionName, const std::string sID);
RandomMove();
Calls the base class’s constructor and saves the action name.
pPop
A pointer to the SPopulation object performing this action.
pCG
A pointer to the SCellGrid object on which the simulation runs.
sActionName
Name of this action.
sID
An ID for this action.
destructor
¶
virtual ~RandomMove();
The destructor.
execute
¶
virtual int execute(int iAgentIndex, float fT);
iAgentIndex
Current agent’s index.
fT
Simulation time.
extractAttributes
¶
virtual int extractAttributesQDF(hid_t hSpeciesGroup);
hSpeciesGroup
HDF handle for the species group to read from.
This method reads the move probability from a QDF file.
writeAttributes
¶
virtual int writeAttributesQDF(hid_t hSpeciesGroup);
hSpeciesGroup
HDF handle for the species group to write to.
This method writes the move probability to the specified group in a QDF file.
tryGetAttributes
¶
virtual int tryGetAttributes(const ModuleComplex *pMC);
pMC
A
ModuleComplex
object.
Extracts the move probability from the ModuleComplex
object.
modifyAttributes
¶
virtual int modifyAttributes(const std::string sAttrName, double dValue);
sAttrName
Name of attribute to change.
dValue
Value to set the attribute to.
The only attribute that can be changed is obviously "RandomMove_prob"
.
isEqual
¶
virtual bool isEqual(Action<T> *pAction, bool bStrict);
pAction
Pointer to an action object to compare with this.
bStrict
Strictness of comparisons (ignored here).
pAction
is equal to this
, if it is a RandomMove
object whose mpve probability is the same as the one of this.