org.cloudbus.cloudsim.core

Interface SimEntity

All Superinterfaces:

Cloneable, Comparable<SimEntity>, Identificable, Nameable, Runnable

All Known Subinterfaces:

Datacenter, DatacenterBroker, Switch

All Known Implementing Classes:

AbstractSwitch, AggregateSwitch, CloudInformationService, CloudSimEntity, DatacenterBrokerAbstract, DatacenterBrokerHeuristic, DatacenterBrokerSimple, DatacenterSimple, EdgeSwitch, HostFaultInjection, NetworkDatacenter, RootSwitch

public interface SimEntity
extends Nameable, Cloneable, Runnable, Comparable<SimEntity>

An interface that represents a simulation entity. An entity handles events and can send events to other entities.

Since:

CloudSim Plus 1.0

Author:

Marcos Dias de Assuncao, Manoel Campos da Silva Filho

See Also:

CloudSimEntity

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SimEntity.State Defines the event state.

Field Summary

Fields

Modifier and Type	Field and Description
static SimEntity	NULL An attribute that implements the Null Object Design Pattern for SimEntity objects.

Method Summary

Modifier and Type	Method and Description
Simulation	getSimulation() Gets the CloudSim instance that represents the simulation to each the Entity is related to.
boolean	isAlive() Checks if the entity is alive, i.e, it's not finished.
boolean	isFinished() Checks if the entity is finished or not.
boolean	isStarted() Checks if the entity already was started or not.
void	processEvent(SimEvent ev) Processes events or services that are available for the entity.
void	run() The run loop to process events fired during the simulation.
void	schedule(SimEntity dest, double delay, int tag) Sends an event to another entity with no attached data.
void	setLog(boolean log) Define if log is enabled for this particular entity or not.
SimEntity	setName(String newName) Sets the Entity name.
SimEntity	setSimulation(Simulation simulation) Sets the CloudSim instance that represents the simulation the Entity is related to.
SimEntity	setState(SimEntity.State state)
void	shutdownEntity() Shuts down the entity.
void	start() Starts the entity during simulation start.

Methods inherited from interface org.cloudbus.cloudsim.core.Nameable

getName

Methods inherited from interface org.cloudbus.cloudsim.core.Identificable

getId

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

NULL

static final SimEntity NULL

An attribute that implements the Null Object Design Pattern for SimEntity objects.

Method Detail

setState

SimEntity setState(SimEntity.State state)

isStarted

boolean isStarted()

Checks if the entity already was started or not.

Returns:

isAlive

boolean isAlive()

Checks if the entity is alive, i.e, it's not finished.

Returns:

isFinished

boolean isFinished()

Checks if the entity is finished or not.

Returns:

getSimulation

Simulation getSimulation()

Gets the CloudSim instance that represents the simulation to each the Entity is related to.

Returns:

setSimulation

SimEntity setSimulation(Simulation simulation)

Sets the CloudSim instance that represents the simulation the Entity is related to.

Parameters:

simulation - The CloudSim instance that represents the simulation the Entity is related to

Returns:

processEvent

void processEvent(SimEvent ev)

Processes events or services that are available for the entity. This method is invoked by the CloudSim class whenever there is an event in the deferred queue, which needs to be processed by the entity.

Parameters:

ev - information about the event just happened

Precondition:

ev != null

Postcondition:

$none

schedule

void schedule(SimEntity dest,
              double delay,
              int tag)

Sends an event to another entity with no attached data.

Parameters:

dest - the destination entity

delay - How many seconds after the current simulation time the event should be sent

tag - An user-defined number representing the type of event.

run

void run()

The run loop to process events fired during the simulation. The events that will be processed are defined in the processEvent(SimEvent) method.

Specified by:

run in interface Runnable

See Also:

processEvent(SimEvent)

start

void start()

Starts the entity during simulation start. This method is invoked by the CloudSim class when the simulation is started.

shutdownEntity

void shutdownEntity()

Shuts down the entity. This method is invoked by the CloudSim before the simulation finishes. If you want to save data in log files this is the method in which the corresponding code would be placed.

setName

SimEntity setName(String newName)
           throws IllegalArgumentException

Sets the Entity name.

Parameters:

newName - the new name

Returns:

Throws:

IllegalArgumentException - when the entity name is null or empty

setLog

void setLog(boolean log)

Define if log is enabled for this particular entity or not.

Parameters:

log - true to enable logging, false to disable