A B C D E F G H I L M N O P Q R S T U V W X Y Z

A

abort() - Method in class yass.radio.Reception

Changes the internal state to reflect the abandonment of this Reception by its owner RadioModule, and calls-back the owner RadioModule with the news that this has happened.

abort() - Method in class yass.radio.Transmission

Updates this Transmission and any remaining listener Reception objects to indicate that message transmission has been abandoned by the transmitter prior to completion.

absoluteError() - Method in class yass.clock.ClockModule

Returns the local time minus the simulation time, which indicates how far ahead or behind the simulation time the local time measurement is.

accept(Packet) - Method in class yass.gossip.BoostDistanceFromSourceGossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.gossip.BoostDistanceToDestinationGossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.gossip.BoostHopsTraversedGossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.gossip.BoostTimeFromCreationGossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.gossip.GossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.gossip.IggAngleGossipPacketConsumer

Probabilisticly rebroadcast a packet.

accept(Packet) - Method in class yass.gossip.IggDistanceGossipPacketConsumer

Probabilisticly rebroadcast a packet.

accept(Packet) - Method in class yass.gossip.PathBoundedGossipPacketConsumer

Rebroadcasts with a given probability.

accept(Packet) - Method in class yass.igf.IgfPacketConsumer

Examines the supplied packet and forwards it for further processing.

accept(Packet) - Method in class yass.modularforwarding.gossip.ModularGossipPacketConsumer

Probabilisticly rebroadcast a packet.

accept(Packet) - Method in class yass.traffic.consumer.DestinationPacketConsumer

Examines the supplied packet.

accept(Packet) - Method in class yass.traffic.consumer.DropCachedPacketConsumer

Accepts an incoming packet.

accept(Packet) - Method in class yass.traffic.consumer.PacketConsumer

Accepts the supplied packet.

accept(Packet) - Method in class yass.traffic.consumer.TerminatingPacketConsumer

Drops the supplied packet.

accepted - Variable in class yass.packet.schedule.PacketScheduler

Accepted schedule entries counter

acceptReceivedPacket(Packet) - Method in class yass.network.Node

Forwards a received Packet to the PacketConsumer chain-of-command, after amending the packet to include this Node in its Route

acceptTransmission(Transmission) - Method in class yass.radio.RadioModule

Determines if the RadioModule will accept the proposed incoming Transmission.

ackHeaderSize - Variable in class yass.igf.IgfPacketSchedulerConfig

Header size for an ACK packet, in bits

active - Variable in class yass.traffic.producer.PacketProducer

Flag indicating whether packets are currently produced

actualPhysicalDistances - Variable in class yass.analysis.AnalysisResults

Statistics about actual-traversed-path distances between source and sink for delivered packets

actualPhysicalSpeeds - Variable in class yass.analysis.AnalysisResults

Statistics about actual-traversed-path speeds between source and sink for delivered packets

add(K, V) - Method in interface yass.util.Collector

Adds a new instance object corresponding to a given key to the collector.

add(K, V) - Method in class yass.util.ListCollector

Adds a new instance object corresponding to a given key to the collector.

add(Position) - Method in class yass.util.Position

Returns a new position found by adding each ordinate of the specified Position to the corresponding ordinate of this Position.

add(K, V) - Method in class yass.util.SetCollector

Adds a new instance object corresponding to a given key to the collector.

addCompletionCriterion(CompletionCriterion) - Method in class yass.simulation.Simulator

Adds the specified completion criterion to those which must be satisfied prior to conclusion of simulation activity

addEventClass(Class) - Method in class yass.database.Database

Adds the specified class to the set of managed event classes.

addNewSimulations() - Method in class yass.experiment.ExperimentManager

Compares the number of currently running simulations to the maximum permitted, starting new simulations if possible to make up any shortfall.

addScoreGenerator(ScoreGenerator, double) - Method in class yass.modularforwarding.scoring.ScoreManager

Adds the supplied ScoreGenerator to the set of active score generators

addStateTransitionCost(StateTransition, double) - Method in class yass.energy.StateCostModel

Stores a new state transition energy cost, replacing any existing stored cost for the given state transition

addSteadyStateCost(State, double) - Method in class yass.energy.StateCostModel

Stores a new steady-state energy cost, replacing any existing stored cost for the given state

Advanceable - Interface in yass.simulation

A time-aware simulated entity which independently updates its own internal state, and that of any other simulated entities for which it is responsible, in response to an advancement of simulated time by the network simulator.

advanceTime(double) - Method in class yass.backoff.BackoffManager

Advances time for the backoff manager by the specified number of seconds

advanceTime(double) - Method in class yass.clock.ClockModule

Advances time for the ClockModule by the duration specified in seconds.

advanceTime(double) - Method in class yass.clock.GaussianErrorClockModule

Advances time for the ClockModule by the duration specified in seconds.

advanceTime(double) - Method in class yass.clock.PerfectClockModule

Dummy implementation; does nothing.

advanceTime(double) - Method in class yass.energy.EnergyModule

Advances time for the simulated energy source and registered energy consumers by the duration specified in seconds

advanceTime(double) - Method in interface yass.energy.EnergySource

Advances time for the simulated energy source by the duration specified in seconds.

advanceTime(double) - Method in class yass.energy.SimpleEnergySource

SimpleEnergySource implementations have no time-dependant behaviour, so calling this method has no effect.

advanceTime(double) - Method in class yass.igf.IgfDummyPacketProducer

Advances time for the PacketProducer, but actually does nothing.

advanceTime(double) - Method in class yass.igf.IgfPacketScheduler

Advances time for the IgfPacketScheduler instance by a duration specified in seconds.

advanceTime(double) - Method in class yass.packet.schedule.PacketScheduler

Advances time for the PacketScheduler instance by a duration specified in seconds.

advanceTime(double) - Method in class yass.radio.RadioModule

Advances simulated time for the RadioModule instance

advanceTime(double) - Method in class yass.radio.Transmission

Advances time for this Transmission by the supplied period, implicitly advancing the time of any listening Reception objects.

advanceTime(double) - Method in interface yass.simulation.Advanceable

Advances time for the Advanceable instance by a duration specified in seconds

advanceTime(double) - Method in class yass.simulation.Simulation

Progresses simulation time by the supplied amount.

advanceTime(double) - Method in class yass.state.StateManager

Advances time for this StateManager by the duration specified in seconds.

advanceTime(double) - Method in class yass.traffic.producer.PacketProducer

Advances time for the PacketProducer, which must decide if it is to produce a packet in this period of time.

advanceTime(double) - Method in class yass.traffic.producer.RatePacketProducer

Advances time for the PacketProducer, which must decide if it is to produce a packet in this period of time.

advanceTime(double) - Method in class yass.traffic.producer.SpecifiedPacketProducer

Advances time for the PacketProducer, which must decide if it is to produce a packet in this period of time.

advanceTime(double) - Method in class yass.traffic.producer.SporadicPacketProducer

Advances time for the SporadicPacketProducer, which must decide if it is to produce a packet in this period of time.

advanceTimeForPacketCreators(double) - Method in class yass.network.Node

Advances time for the internal packet production and processing of a Node

allFinished - Variable in class yass.experiment.SimulatorContainerThread

Flag indicating that everything is now finished

AlwaysCompleteCompletionCriterion - Class in yass.simulation

Dummy completion criterion for simulation, which always decides that the simulation is complete regardless of the state of the simulation.

AlwaysCompleteCompletionCriterion() - Constructor for class yass.simulation.AlwaysCompleteCompletionCriterion

Creates a new instance of AlwaysCompleteCompletionCriterion

AlwaysInterestedNodePacketInterestPolicy - Class in yass.packet.interest

Policy under which the owner node is always interested in receiving every packet it has the option of receiving.

AlwaysInterestedNodePacketInterestPolicy() - Constructor for class yass.packet.interest.AlwaysInterestedNodePacketInterestPolicy

Creates a new instance of AlwaysInterestedNodePacketInterestPolicy

analyse() - Method in class yass.analysis.Analyser

Analyses the specified simulation state, without modifying that simulation state, and produces a set of analytical results pertinent to the simulated time at which the analyse() method is called

analyse() - Method in class yass.analysis.FullAnalyser

Analyses the current simulation state

analyse() - Method in class yass.experiment.SimulatorContainerThread

Runs the analysis to completion

analyseDeliveryDistributions() - Method in class yass.analysis.FullAnalyser

Analyses distributions of metrics associated with packet delivery success and failure, from which investigators can derive an understanding of where failures in message delivery are concentrated.

analysedPacketType - Variable in class yass.experiment.ExperimentManager

Type of packet to consider in analysis, or PacketType.ALL to consider all types

analysedPacketType - Variable in class yass.experiment.SimulatorContainerThread

The type of generated packet to consider in analysis, or PacketType.ALL if all types are to be considered equally,

analyseEnergy() - Method in class yass.analysis.FullAnalyser

Analyses the energy consumed by simulated network activity

analyseMessagePropagation() - Method in class yass.analysis.FullAnalyser

Analyses success of message propagation within the simulated network

analyseNetwork() - Method in class yass.analysis.FullAnalyser

Analyses the network and its participating nodes

analyseNetworkTraffic() - Method in class yass.analysis.FullAnalyser

Analyses traffic in the simulated network

analyseNetworkTrafficEnergy() - Method in class yass.analysis.FullAnalyser

Analyses energy expended on traffic in the simulated network

analyseNodeStates() - Method in class yass.analysis.FullAnalyser

Analyses the states adopted by nodes during simulation

analysePointToPointSuccess() - Method in class yass.analysis.FullAnalyser

Analyses success of point-to-point activity in the simulated network

Analyser - Class in yass.analysis

Abstract class defining the general contract of a simulation state analyser

Analyser(Simulation) - Constructor for class yass.analysis.Analyser

Creates a new instance of Analyser

analyseRadioModuleStates() - Method in class yass.analysis.FullAnalyser

Analyses the states adopted by radio modules during simulation

analysing - Variable in class yass.experiment.SimulatorContainerThread

Flag indicating current analysis activity

ANALYSIS_RESULTS_KEY - Static variable in class yass.util.SerialGenerator

The serial key to use when identifying analysis results sets

analysisComplete - Variable in class yass.experiment.SimulatorContainerThread

Flag indicating analysis completeness

AnalysisCompleteEvent - Class in yass.database

Instances of this class capture the event of a simulation results analysis session completing, and are responsible for commiting the resulting analytical results into the event database.

AnalysisCompleteEvent(AnalysisResults, boolean) - Constructor for class yass.database.AnalysisCompleteEvent

Creates a new instance of AnalysisCompleteEvent

AnalysisCompleteEvent(AnalysisResults) - Constructor for class yass.database.AnalysisCompleteEvent

Creates a new instance of AnalysisCompleteEvent.

AnalysisException - Exception in yass.analysis

Describes a problem encountered while analysing a simulation state

AnalysisException() - Constructor for exception yass.analysis.AnalysisException

Creates a new instance of AnalysisException without detail message.

AnalysisException(String) - Constructor for exception yass.analysis.AnalysisException

Constructs an instance of AnalysisException with the specified detail message.

analysisFinished - Variable in class yass.analysis.Analyser

Flag indicating whether analysis activity is complete

analysisInterval - Variable in class yass.experiment.ExperimentManager

Number of simulation cycles between periodic analyses

analysisInterval - Variable in class yass.experiment.SimulatorContainerThread

Number of simulation iterations between analysis iterations, disabled if set to a non-positive value

analysisMode - Variable in class yass.database.Database

Whether the database is in analysis mode, which is read-only for optimised performance

AnalysisResults - Class in yass.analysis

Instances of this class are containers for analytical results pertaining to a given simulation state.

AnalysisResults(int, int, double) - Constructor for class yass.analysis.AnalysisResults

Creates a new instance of AnalysisResults

analysisStartTimeMillis - Variable in class yass.analysis.FullAnalyser

Result of System.currentTimeMillis() at start of analysis; used to calculate how long has been spent during analysis

analysisTimeSeconds() - Method in class yass.analysis.FullAnalyser

ApacheDerbyDatabase - Class in yass.database

An implementation of a simulation database using the Apache Derby DBMS for lower-level data storage

ApacheDerbyDatabase() - Constructor for class yass.database.ApacheDerbyDatabase

Creates a new instance of ApacheDerbyDatabase using default values for reasonable but untuned performance.

ApacheDerbyDatabase(String) - Constructor for class yass.database.ApacheDerbyDatabase

Creates a new instance of ApacheDerbyDatabase using default values for reasonable but untuned performance

ApacheDerbyDatabase(String, String, String, String, Set<Class>, int, boolean, boolean) - Constructor for class yass.database.ApacheDerbyDatabase

Creates a new instance of ApacheDerbyDatabase

appendNode(Node) - Method in class yass.network.Route

Appends the supplied node to the end of the existing Route

appendToTrace(Node) - Method in class yass.packet.Packet

Appends an additional node to the existing node-traversal trace

APPLICATION_GENERATED_DATA_INDEX - Static variable in class yass.packet.PacketHeaderFieldKeys

Tags items of data generated by the application that may be temporarily fragmented by the network

ArithmeticProgressionBackoffManager - Class in yass.backoff

Backoff manager in which the sequence of backoff periods forms an arithmetic progression

ArithmeticProgressionBackoffManager(double, double, int) - Constructor for class yass.backoff.ArithmeticProgressionBackoffManager

Creates a new instance of ArithmeticProgressionBackoffManager

AsapBoundedDropOldestPacketScheduler - Class in yass.packet.schedule

Simple packet scheduler implementation in which packets are scheduled such that they enter and leave the scheduler in strict FIFO order, and are always available for transmission at any time.

AsapBoundedDropOldestPacketScheduler(int) - Constructor for class yass.packet.schedule.AsapBoundedDropOldestPacketScheduler

Creates a new instance of AsapBoundedDropOldestPacketScheduler

AsapBoundedDropRandomPacketScheduler - Class in yass.packet.schedule

Simple packet scheduler implementation in which packets are scheduled such that they enter and leave the scheduler in strict FIFO order, and are always available for transmission at any time.

AsapBoundedDropRandomPacketScheduler(int) - Constructor for class yass.packet.schedule.AsapBoundedDropRandomPacketScheduler

Creates a new instance of AsapBoundedDropOldestPacketScheduler

AsapPacketScheduler - Class in yass.packet.schedule

Simple packet scheduler implementation in which packets are scheduled such that they enter and leave the scheduler in strict FIFO order, are always available for transmission at any time, and are never dropped.

AsapPacketScheduler() - Constructor for class yass.packet.schedule.AsapPacketScheduler

Constructs a new instance of AsapPacketScheduler

asNodeList() - Method in class yass.network.Route

Unmodifiable ordered list of asNodeList present in the route

attemptBackoff() - Method in class yass.backoff.ArithmeticProgressionBackoffManager

Attempts to initiate a new backoff period, the duration of which is the next term in the arithmetic sequence

attemptBackoff() - Method in class yass.backoff.BackoffManager

Attempts to initiate a new backoff period.

attemptBackoff() - Method in class yass.backoff.ExponentialBackoffManager

Attempts to initiate a new backoff period

attemptBackoff() - Method in class yass.backoff.GeometricProgressionBackoffManager

Attempts to initiate a new backoff period, the duration of which is the next term in the geometric sequence

attemptBackoff() - Method in class yass.backoff.PowerProgressionBackoffManager

Attempts to initiate a new backoff period, the duration of which is the next term in the power sequence

attemptBackoff() - Method in class yass.backoff.RandomBackoffManager

Attempts to initiate a new backoff period

attemptTransmissionStart(double) - Method in class yass.network.Node

Attempts to begin transmitting the next scheduled packet if any such packets are scheduled for transmission and the radio module is available to do so.

attemptTransmissionStart() - Method in class yass.radio.Transmission

Starts transmitting data if the wireless medium is available.

attenuation(Position, Position, double) - Method in class yass.network.SphericalVoid

Determines the extent to which a signal transmitted along the straight line segment from start to end is attenuated by this void.

attenuation(Position, Position, double) - Method in interface yass.network.Void

Determines the extent to which a signal transmitted along the straight line segment from start to end is attenuated by this void.

autoIncrementPrimaryKeyFragment(DatabaseType) - Static method in class yass.database.SqlFragments