ctu.nengoros.util.sync.impl

Class SyncedUnit

java.lang.Object

ctu.nengoros.util.sync.impl.SyncedUnit

All Implemented Interfaces:

SyncedUnitInterface

Direct Known Subclasses:

BasicDecoder, DefaultNeuralModule

public abstract class SyncedUnit
extends java.lang.Object
implements SyncedUnitInterface

Class for synchronization (e.g. Nengo with ROS components) of arbitrary components. The Unit has two states: ready/notReady, Unit is ready if the following is true:

• has set flag: asynchronous=true (simulation is not waiting for it)
• all its childs are ready
• does not have any childs and is set to state: ready

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	synchronous

Constructor Summary

Constructors

Constructor and Description
SyncedUnit()
SyncedUnit(boolean synchronous)
SyncedUnit(boolean synchronous, java.lang.String name)
SyncedUnit(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(SyncedUnitInterface child) enables to create tree of units unit is ready if all childs are ready or if flag "alwaysReady" is on
void	discardChildsReady() Make me and all childs not ready (except those set to asynchronous - alwaysready)
java.lang.String	getName()
boolean	isReady()
void	removeChild(SyncedUnitInterface child)
void	setName(java.lang.String name)
void	setReady(boolean ready)
void	setSynchronous(boolean synchronous)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

synchronous

protected boolean synchronous

Constructor Detail

SyncedUnit

public SyncedUnit(java.lang.String name)

SyncedUnit

public SyncedUnit(boolean synchronous,
          java.lang.String name)

SyncedUnit

public SyncedUnit()

SyncedUnit

public SyncedUnit(boolean synchronous)

Method Detail

setSynchronous

public void setSynchronous(boolean synchronous)

Specified by:

setSynchronous in interface SyncedUnitInterface

isReady

public boolean isReady()

Specified by:

isReady in interface SyncedUnitInterface

setReady

public void setReady(boolean ready)

Specified by:

setReady in interface SyncedUnitInterface

addChild

public void addChild(SyncedUnitInterface child)

Description copied from interface: SyncedUnitInterface

enables to create tree of units unit is ready if all childs are ready or if flag "alwaysReady" is on

Specified by:

addChild in interface SyncedUnitInterface

removeChild

public void removeChild(SyncedUnitInterface child)

Specified by:

removeChild in interface SyncedUnitInterface

setName

public void setName(java.lang.String name)
             throws StructuralException

Specified by:

setName in interface SyncedUnitInterface

Throws:

StructuralException

getName

public java.lang.String getName()

Specified by:

getName in interface SyncedUnitInterface

discardChildsReady

public void discardChildsReady()

Description copied from interface: SyncedUnitInterface

Make me and all childs not ready (except those set to asynchronous - alwaysready)

Specified by:

discardChildsReady in interface SyncedUnitInterface