Interface ILogicVarBundle

All Known Subinterfaces:

IPosBcast, IVoronoiHolder

All Known Implementing Classes:

BcastStorage, LogicVarIntLookup, PairLogicVarBundle, SimpleFlockingAgent.SimpFlockState, TreeAgentState, TreeConstraintState, VicsekFlockingAgent.SimpFlockState, VoronoiHolder

public interface ILogicVarBundle

ILogicVarBundle is the interface for the discrete component of robotic agent state. This is the component of DiscreteAgentState that gets fed back into the agent for the next round of

Since:

1.0

Method Summary

java.lang.Boolean	getBoolVar(java.lang.Object refObject) gets a Boolean (wrapping a boolean) referred to by an object.
int	getId() Gets unique Id of this agent
java.lang.Integer	getIntVar(java.lang.Object refObject) gets an Integer (wrapping an int) referred to by an object.
boolean	insertBoolVar(java.lang.Object refObject, boolean bValue) inserts an boolean value (see getBoolVar).
boolean	insertIntVar(java.lang.Object refObject, int nValue) inserts an integer value (see getIntvar).
ILogicVarBundle	makeCopy() makes a copy and returns it
void	removeVar(java.lang.Object refObject) Removes any values indexed by refObject
void	setId(int nId) Sets unique Id of this agent

Method Detail

makeCopy

ILogicVarBundle makeCopy()

makes a copy and returns it

getIntVar

java.lang.Integer getIntVar(java.lang.Object refObject)

gets an Integer (wrapping an int) referred to by an object. returns null if refObject is of invalid type or indexes an invalid logic var. Note: The original specification only allowed boolean variables in this place. Obviously some applications may want to use collections of boolean variables to represent integers over a finite fixed range, or rationals with finite fixed precision over a finite fixed range. This function is merely provided as a shortcut towards this end.

insertIntVar

boolean insertIntVar(java.lang.Object refObject,
                     int nValue)

inserts an integer value (see getIntvar). Returns fals if this insert was not permitted

See Also:

getIntVar(java.lang.Object)

getBoolVar

java.lang.Boolean getBoolVar(java.lang.Object refObject)

gets a Boolean (wrapping a boolean) referred to by an object. returns null if refObject is of invalid type or indexes an invalid logic var.

insertBoolVar

boolean insertBoolVar(java.lang.Object refObject,
                      boolean bValue)

inserts an boolean value (see getBoolVar). Returns fals if this insert was not permitted

See Also:

getBoolVar(java.lang.Object)

removeVar

void removeVar(java.lang.Object refObject)

Removes any values indexed by refObject

Parameters:

refObject - remove values associated with this.

getId

int getId()

Gets unique Id of this agent

setId

void setId(int nId)

Sets unique Id of this agent