org.graphstream.boids
Class BoidGenerator

java.lang.Object
  org.graphstream.stream.SourceBase
      org.graphstream.boids.BoidGenerator

All Implemented Interfaces:

org.graphstream.algorithm.generator.Generator, org.graphstream.stream.Source

public class BoidGenerator
extends org.graphstream.stream.SourceBase
implements org.graphstream.algorithm.generator.Generator

A generator using a boid graph to create a dynamic graph.

Author:

Guilhelm Savin, Antoine Dutot

Nested Class Summary

Nested classes/interfaces inherited from class org.graphstream.stream.SourceBase

org.graphstream.stream.SourceBase.ElementType

Constructor Summary

BoidGenerator()
Create a new boid generator with no configuration.

BoidGenerator(String dgsConfiguration)
Create a new boid generator specifying a configuration to load when generation starts.

Method Summary

void	begin()
void	end()
BoidGraph	getBoidGraph() Get the boid graph used by this generator to produce events.
boolean	nextEvents()

Methods inherited from class org.graphstream.stream.SourceBase

addAttributeSink, addElementSink, addSink, attributeSinks, clearAttributeSinks, clearElementSinks, clearSinks, elementSinks, removeAttributeSink, removeElementSink, removeSink, sendAttributeChangedEvent, sendAttributeChangedEvent, sendEdgeAdded, sendEdgeAdded, sendEdgeAttributeAdded, sendEdgeAttributeAdded, sendEdgeAttributeChanged, sendEdgeAttributeChanged, sendEdgeAttributeRemoved, sendEdgeAttributeRemoved, sendEdgeRemoved, sendEdgeRemoved, sendGraphAttributeAdded, sendGraphAttributeAdded, sendGraphAttributeChanged, sendGraphAttributeChanged, sendGraphAttributeRemoved, sendGraphAttributeRemoved, sendGraphCleared, sendGraphCleared, sendNodeAdded, sendNodeAdded, sendNodeAttributeAdded, sendNodeAttributeAdded, sendNodeAttributeChanged, sendNodeAttributeChanged, sendNodeAttributeRemoved, sendNodeAttributeRemoved, sendNodeRemoved, sendNodeRemoved, sendStepBegins, sendStepBegins

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graphstream.stream.Source

addAttributeSink, addElementSink, addSink, clearAttributeSinks, clearElementSinks, clearSinks, removeAttributeSink, removeElementSink, removeSink

Constructor Detail

BoidGenerator

public BoidGenerator()

Create a new boid generator with no configuration.

BoidGenerator

public BoidGenerator(String dgsConfiguration)

Create a new boid generator specifying a configuration to load when generation starts.

Parameters:

dgsConfiguration - the configuration

Method Detail

getBoidGraph

public BoidGraph getBoidGraph()

Get the boid graph used by this generator to produce events. This graph only exists between calls to begin() and end().

Returns:

the boid graph

begin

public void begin()

Specified by:

begin in interface org.graphstream.algorithm.generator.Generator

end

public void end()

Specified by:

end in interface org.graphstream.algorithm.generator.Generator

nextEvents

public boolean nextEvents()

Specified by:

nextEvents in interface org.graphstream.algorithm.generator.Generator