org.debellor.core.cell
Class SingleSample

java.lang.Object
  org.debellor.core.Cell
      org.debellor.core.cell.SingleSample

public class SingleSample
extends Cell

Buffer which holds at most one Sample, passed into the buffer by a special method put(org.debellor.core.Sample). Useful when samples must be passed to a cell one-by-one, under control of an outside procedure. With method isEmpty() it can be checked whether the receiving cell has "eaten" up the sample or not.

Author:

Marcin Wojnarski

Nested Class Summary

Nested classes/interfaces inherited from class org.debellor.core.Cell

Cell.CellMethod, Cell.State, Cell.Stream

Field Summary

protected Sample.SampleType

type

Fields inherited from class org.debellor.core.Cell

parameters, random

Constructor Summary

SingleSample()

Method Summary

boolean	isEmpty()
protected void	onClose() Called by Cell.Stream.close().
protected Sample	onNext() Called by Cell.Stream.next().
protected Sample.SampleType	onOpen() Called by Cell.open().
void	put(Sample s)
void	setType(Sample.SampleType type)

Methods inherited from class org.debellor.core.Cell

close, erase, getAvailableParams, getParameters, learn, newThread, newThread, next, onErase, onLearn, open, openInputStream, set, set, set, set, setAvailableParams, setParameters, setRandomSeed, setSource, state, toString

Methods inherited from class java.lang.Object

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

Field Detail

type

protected Sample.SampleType type

Constructor Detail

SingleSample

public SingleSample()

Method Detail

isEmpty

public boolean isEmpty()

put

public void put(Sample s)

onOpen

protected Sample.SampleType onOpen()
                            throws java.lang.Exception

Description copied from class: Cell

Called by Cell.open(). Performs the actual opening of communication session, while open checks only against access violation and handles exceptions. Must be overridden in subclasses if open is to be used. Overriders may assume that the cell is in Cell.State.CLOSED state.

Overrides:

onOpen in class Cell

Throws:

java.lang.Exception

onNext

protected Sample onNext()
                 throws java.lang.Exception

Description copied from class: Cell

Called by Cell.Stream.next(). Performs the actual generation of the next output sample, while Stream.next() checks only against access violation and handles exceptions. Must be overridden in the subclass if next is to be used, i.e. if the subclass should generate some output data. Overriders may assume that the cell is in Cell.State.OPEN state.

Overrides:

onNext in class Cell

Throws:

java.lang.Exception

onClose

protected void onClose()
                throws java.lang.Exception

Description copied from class: Cell

Called by Cell.Stream.close(). Performs the actual closing of communication session, while close checks only against access violation and handles exceptions. Must be overridden in subclasses if close is to be used. Usually the overrider will use onClose to release resources, to let them be garbage-collected. Overriders may assume that the cell is in Cell.State.OPEN state.

Overrides:

onClose in class Cell

Throws:

java.lang.Exception

setType

public void setType(Sample.SampleType type)