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

C

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

Calculates the physical distance travelled by a packet traversing the asNodeList of this Route in order.

candidateSectorAngle - Variable in class yass.gossip.IggAngleGossipPacketConsumer

The angle between lasthop-destination and lasthop-current vectors within which packet rebroadcast probability is boosted above probabilityMin

capacity - Variable in class yass.energy.SimpleEnergySource

Maximum capacity of energy source, in Joules

capacity - Variable in class yass.packet.cache.BoundedFifoSeenPacketCache

Maximum cache capacity

centre - Variable in class yass.network.SphericalVoid

The centre of the void

changeState(Node.NodeState) - Method in class yass.network.Node

Sets the current state of the node.

changeState(RadioModule.RadioModuleState) - Method in class yass.radio.RadioModule

Changes the state of this RadioModule to the requested new state.

changeState(Reception.ReceptionState) - Method in class yass.radio.Reception

Changes the state of this Reception to the proposed new state, if possible.

changeState(Transmission.TransmissionState) - Method in class yass.radio.Transmission

Attempts to change the state of this Transmission object to the supplied new state

changeState(T) - Method in interface yass.state.StateManagedComponent

Induces a state transition from the current state to the specified state

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

This method should be called by all concrete implementations of the abstract attemptBackoff() method before attempting any backoff.

checkEnergyDepletion() - Method in class yass.state.EnergyAwareStateManager

Checks whether the node's energy supply is fully depleted.

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

Checks whether all simulation and analysis activity for all planned experiments has completed

checkNodeMandatoryModules() - Method in class yass.simulation.Simulation

Checks that all nodes have been supplied with the mandatory modules required for correct minimal operation.

chooseCandidates(Set<IgfPacket>) - Method in class yass.igf.BestWorstCandidateChooser

Examines a set of received CTS packets and selects the node which sent the CTS packet with the lowest score as the single forwarding candidate.

chooseCandidates(Set<IgfPacket>) - Method in interface yass.igf.IgfForwardingCandidateChooser

Examines a set of received CTS packets and decides which, if any, of the CTS packet sending nodes should be selected as a forwarding candidate.

chooseCandidates(Set<IgfPacket>) - Method in class yass.igf.SingleBestCandidateChooser

Examines a set of received CTS packets and selects the node which sent the CTS packet with the lowest score as the single forwarding candidate.

clairvoyancySavingPerBitPercent - Variable in class yass.analysis.AnalysisResults

Energy per delivered bit which would have been saved with a clairvoyant radio state management policy

clairvoyancySavingPerPacketPercent - Variable in class yass.analysis.AnalysisResults

Energy per delivered packet which would have been saved with a clairvoyant radio state management policy

clairvoyantEnergyPerBit - Variable in class yass.analysis.AnalysisResults

Energy consumed per delivered bit if radio had been switched off whenever it was not doing useful work

clairvoyantEnergyPerPacket - Variable in class yass.analysis.AnalysisResults

Energy consumed per delivered packet if radio had been switched off whenever it was not doing useful work

clairvoyantEnergyPerPacketPerHop - Variable in class yass.analysis.AnalysisResults

The energy required to move one packet by one hop in the network.

clairvoyantEnergyPerPacketPerMetre - Variable in class yass.analysis.AnalysisResults

The energy required to move one packet by one metre in the network.

clear() - Method in interface yass.util.Collector

Removes all keys and instances from the Collector

clear() - Method in class yass.util.ListCollector

Removes all keys and instances from the Collector

clear() - Method in class yass.util.SetCollector

Removes all keys and instances from the Collector

CliArgsParser - Class in yass.util

This class provides a quick-and-dirty way to overwrite the default values of fields of a specified object from an array of command line arguments as specified when starting the Java VM.

CliArgsParser() - Constructor for class yass.util.CliArgsParser

ClockModule - Class in yass.clock

A module owned by a given node which keeps track of time, and makes this information available to its peer modules and to the node itself.

ClockModule() - Constructor for class yass.clock.ClockModule

Creates a new instance of ClockModule

clockModule - Variable in class yass.network.Node

The clock module

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

Obtains a new ArithmeticProgressionBackoffManager instance, using the called instance as a template instance

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

Obtains a new BackoffManager instance, using the called instance as a template instance

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

Obtains a new BackoffManager instance, using the called instance as a template instance

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

Obtains a new GeometricProgressionBackoffManager instance, using the called instance as a template instance

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

Obtains a new PowerProgressionBackoffManager instance, using the called instance as a template instance

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

Obtains a new BackoffManager instance, using the called instance as a template instance

clonePrototype(int) - Method in class yass.experiment.ExperimentDefinition

Clones this ExperimentDefinition as a new instance with the supplied ID number, making a shallow copy of the parameter set

clonePrototype() - Method in class yass.igf.IgfPacketInterestPolicy

This method is not supported by IgfPacketInterestPolicy, so an UnsupoortedOperationException will be thrown if called.

clonePrototype() - Method in class yass.packet.interest.AlwaysInterestedNodePacketInterestPolicy

Creates a cloned copy of an AlwaysInterestedNodePacketInterestPolicy instance of the appropriate type, but with the owner node set to null.

clonePrototype() - Method in class yass.packet.interest.NeverInterestedNodePacketInterestPolicy

Creates a cloned copy of a NeverInterestedNodePacketInterestPolicy instance of the appropriate type, but with the owner node set to null.

clonePrototype() - Method in class yass.packet.interest.NodePacketInterestPolicy

Creates a cloned copy of a NodePacketInterestPolicy instance of the appropriate type, but with the owner node set to null.

clonePrototype() - Method in class yass.packet.interest.UnknownHeaderNodePacketInterestPolicy

Creates a cloned copy of a NodePacketInterestPolicy instance of the appropriate type, but with the owner node set to null.

closeConnection() - Method in class yass.database.Database

Closes the connection to the underlying database

coefficient - Variable in class yass.backoff.PowerProgressionBackoffManager

Coefficient by which each member of the power sequence is multiplied as a scaling factor

collection - Variable in class yass.util.ListCollector

Contains all key and instance data

collection - Variable in class yass.util.SetCollector

Contains all key and instance data

Collector<K,V> - Interface in yass.util

Similar to a Map, this class collects object instances corresponding to a given key.

commit() - Method in class yass.database.Database

Forces an immediate database commit without consulting or resetting the database-modifying action counter

commitIfRequired() - Method in class yass.database.Database

If the maximum number of permitted database-modifying operations has been reached, a commit is forced.

compareTo(ExperimentDefinition) - Method in class yass.experiment.ExperimentDefinition

Compares this ExperimentDefinition instance to another, and determines their relative position in their natural ordering

compareTo(Node) - Method in class yass.network.Node

Implementation for the Comparable interface to allow consistent ordering of a Collection of Nodes, which works by comparing the integer node IDs.

compareTo(TimeNodeMapping) - Method in class yass.network.TimeNodeMapping

Compares this TimeNodeMapping to another TimeNodeMapping and works out their relative positions in the natural order

compareTo(PacketScheduleEntry) - Method in class yass.packet.schedule.PacketScheduleEntry

Compares the supplied ScheduledEntry to this PacketScheduleEntry with respect to their natural order, based on schedule times.

compareTo(Object) - Method in class yass.state.StateTransition

Compares an arbitrary object to this StateTransition, and calculates their relationship in accordance with the natural ordering of StateTransition objects.

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

Changes the internal state to reflect the successful completion of data reception, and calls-back the owner RadioModule with this news.

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

Updates this Transmission and any remaining listener Reception objects to indicate that message transmission has successfully completed.

completedExperimentSimulationIdMapping - Variable in class yass.experiment.ExperimentManager

Mapping of experiment definition to simulation ID number, for all completed simulations

completedSimulationThreads - Variable in class yass.experiment.ExperimentManager

Set of now-complete simulation threads, which will be empty if completed threads are made available for garbage collection

completionCriteria - Variable in class yass.simulation.Simulator

The criteria which must be satisfied before simulation activity can end

CompletionCriterion - Class in yass.simulation

Defines a property or observation which must hold true for a simulation to be considered complete.

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

Constructs a new instance of CompletionCriterion

config - Variable in class yass.igf.IgfPacketScheduler

The configuration options data used to tune the behaviour of this IGF packet scheduler.

connection - Variable in class yass.database.Database

Connection to the database

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

Adds energy to the energy reserve if there is sufficient capacity.

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

Adds energy to the energy reserve if there is sufficient capacity.

Constants - Class in yass.util

Container for various simulation-wide constants that don't belong anywhere else, or belong to multiple entities which must be guaranteed to use the same value.

Constants() - Constructor for class yass.util.Constants

Instances of this class should never be constructed

constantScore - Variable in class yass.modularforwarding.scoring.ConstantScoreGenerator

The score generated for any packet

ConstantScoreGenerator - Class in yass.modularforwarding.scoring

Generates a score for a given packet by simply returning a predefined constant value.

ConstantScoreGenerator(double) - Constructor for class yass.modularforwarding.scoring.ConstantScoreGenerator

Creates a new instance of ConstantScoreGenerator

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

Removes energy from the energy reserve.

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

Removes energy from the energy reserve.

consumed - Variable in class yass.traffic.consumer.PacketConsumer

Counter of how many packets were consumed by this consumer

consumers - Variable in class yass.energy.EnergyModule

The energy consumers and their cost models

consumeStateTransitionEnergy(EnergyConsumer, StateTransition) - Method in class yass.energy.EnergyModule

Removes an amount of energy from the energy source as appropriate to the specified EnergyConsumer for the specified state transition.

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

Removes an amount of energy from the energy source as appropriate to each registered EnergyConsumer to maintain its current state for the specifed duration.

copiesReceivedAllPackets - Variable in class yass.analysis.AnalysisResults

Statistics about how many copies of generated packets arrived at each node, considering both those packets which arrived at their intended destinations and those which did not

copiesReceivedDeliveredPackets - Variable in class yass.analysis.AnalysisResults

Statistics about how many copies of generated packets arrived at each node, considering only those packets which arrived at their intended destinations and disregarding those which did not

copy() - Method in class yass.igf.IgfPacket

Copies this packet, supplying an object representing a distinct instance of the same packet.

copy() - Method in class yass.packet.Packet

Copies this packet, supplying an object representing a distinct instance of the same packet.

CorruptionChecker - Interface in yass.failure.dependent

Encapsulates the calculation which determines if a given reception will fail in the context of a given transmission, where the latter is not intended to be associated with the former.

corruptionChecker - Variable in class yass.radio.Reception

Encapsulation of receipt-failure calculation

count - Variable in class yass.analysis.Statistics

The count of raw data items

countAllInstances() - Method in interface yass.util.Collector

Counts the set of all instances corresponding to all keys

countAllInstances() - Method in class yass.util.ListCollector

Counts the set of all instances corresponding to all keys

countAllInstances() - Method in class yass.util.SetCollector

Counts the set of all instances corresponding to all keys

countInstances(K) - Method in interface yass.util.Collector

Counts the set of instances corresponding to a given key

countInstances(K) - Method in class yass.util.ListCollector

Counts the set of instances corresponding to a given key

countInstances(K) - Method in class yass.util.SetCollector

Counts the set of instances corresponding to a given key

countScheduleEntries() - Method in class yass.packet.schedule.PacketScheduler

Obtains the quantity of scheduled packet transmissions

createConnection() - Method in class yass.database.ApacheDerbyDatabase

Creates a connection to the underlying database

createConnection() - Method in class yass.database.Database

Creates a connection to the underlying database server which references a suitable database instance.

createConnection() - Method in class yass.database.HsqldbDatabase

Creates a connection to the underlying database

createConnection() - Method in class yass.database.MySqlDatabase

Creates a connection to the underlying database

createDbProperties() - Method in class yass.database.ApacheDerbyDatabase

Creates a properties object containing the database parameters supplied by the user and application to Apache Derby during database creation

createDbProperties() - Method in class yass.database.HsqldbDatabase

Creates a properties object containing the database parameters supplied by the user and application to HSQLDB during database creation

createDbProperties() - Method in class yass.database.MySqlDatabase

Creates a properties object containing the database parameters supplied by the user and application to Apache Derby during database creation

createEventDatabaseException(String, Exception) - Static method in exception yass.database.DatabaseException

Constructs an instance of DatabaseException to wrap any ther exception, including the specified message, the name of the wrapped exception, and the stack trace of the wrapped exception.

createException(String, Exception) - Method in class yass.analysis.FullAnalyser

Builds an AnalysisException to wrap the provided message and lower-level exception

createInsertionPreparedStatement(Database) - Static method in class yass.database.NodePositionChangeEvent

Creates a database prepared statement with which to insert node location transition events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.NodeStateTransitionEvent

Creates a database prepared statement with which to insert node state transition events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.PacketGeneratedEvent

Creates a database prepared statement with which to insert packet generation events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.PacketReceivedEvent

Creates a database prepared statement with which to insert packet receipt events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.RadioModuleStateTransitionEvent

Creates a database prepared statement with which to insert radio module state transition events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.ReceptionEvent

Creates a database prepared statement with which to insert packet reception ending events into the database

createInsertionPreparedStatement(Database) - Static method in class yass.database.TransmissionEvent

Creates a database prepared statement with which to insert packet transmission ending events into the database

createInsertStatements(Database) - Static method in class yass.database.AnalysisCompleteEvent

Creates a set of prepared statements, each encompassing the actions required to store a portion of an analytical results set into the requisite events database table.

createNewSimulatorThreads(int) - Method in class yass.experiment.ExperimentManager

Creates the specified number of new simulation threads, using the set of waiting experiment definitions.

createPreparedStatement(String) - Method in class yass.database.Database

Obtains a JDBC PreparedStatement from the current connection.

createStatement() - Method in class yass.database.Database

Obtains a JDBC Statement from the current connection.

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

Creates the set of temporary tables to hold working data required during analysis, which can be safely discarded when analysis completes.

creationTimestamp - Variable in class yass.packet.Packet

The time at which this packet was created

creator - Variable in class yass.experiment.ExperimentManager

Object which creates Simulator instances from ExperimentDefinition instances

ctsHeaderSize - Variable in class yass.igf.IgfPacketSchedulerConfig

Header size for a CTS packet, in bits

ctsPacketScore - Variable in class yass.igf.IgfPacket

The CTS packet score.

ctsThresholdAngle - Variable in class yass.igf.IgfPacketSchedulerConfig

The maximum angle, in degrees, within which a CTS packet will be generated upon receipt of an ORTS packet

currentBackoffPeriod - Variable in class yass.backoff.BackoffManager

The current backoff period, in seconds

currentBackoffRemaining - Variable in class yass.backoff.BackoffManager

The remaining backoff time in the current backoff period, in seconds

currentCacheEntryCount() - Method in class yass.packet.cache.SeenPacketCache

Obtains a count of the packets currently in the cache

currentDataPacket - Variable in class yass.igf.IgfPacketScheduler

The current application data packet, wrapped up in an IGF data packet, with which the current IGF activity is associated.

currentSequenceNumber - Variable in class yass.igf.IgfPacketScheduler

The number with which the current sequence of related IGF packets is identified, to distinguish these from other unrelated concurrent data flows.

currentTransmitPower - Variable in class yass.radio.RadioModule

Current transmission power, in Watts