GridSim 5.0 beta

gridsim.net.flow
Interface Flow


public interface Flow

This the structure for network flows.

Since:
GridSim Toolkit 4.2
Author:
James Broberg, The University of Melbourne

Method Summary
 int getDestID()
          Returns the destination id of this flow.
 int getID()
          Returns the ID of this flow
 int getLast()
          Gets an entity ID from the last hop that this packet has traversed.
 int getNetServiceType()
          Gets the network service type of this flow
 long getSize()
          Returns the size of this flow
 int getSrcID()
          Returns the ID of the source of this flow.
 int getTag()
          Gets this flow tag
 void setLast(int last)
          Sets an entity ID from the last hop that this packet has traversed.
 void setNetServiceType(int serviceType)
          Sets the network service type of this flow.
 boolean setSize(long size)
          Sets the size of this flow
 String toString()
          Returns a string describing this flow in detail.
 

Method Detail

toString

String toString()
Returns a string describing this flow in detail.

Overrides:
toString in class Object
Returns:
description of this flow
Pre Condition:
$none
Post Condition:
$none

getSize

long getSize()
Returns the size of this flow

Returns:
size of the flow
Pre Condition:
$none
Post Condition:
$none

setSize

boolean setSize(long size)
Sets the size of this flow

Parameters:
size - size of the flow
Returns:
true if it is successful, false otherwise
Pre Condition:
size >= 0
Post Condition:
$none

getDestID

int getDestID()
Returns the destination id of this flow.

Returns:
destination id
Pre Condition:
$none
Post Condition:
$none

getID

int getID()
Returns the ID of this flow

Returns:
flow ID
Pre Condition:
$none
Post Condition:
$none

getSrcID

int getSrcID()
Returns the ID of the source of this flow.

Returns:
source id
Pre Condition:
$none
Post Condition:
$none

getNetServiceType

int getNetServiceType()
Gets the network service type of this flow

Returns:
the network service type
Pre Condition:
$none
Post Condition:
$none

setNetServiceType

void setNetServiceType(int serviceType)
Sets the network service type of this flow.

By default, the service type is 0 (zero). It is depends on the packet scheduler to determine the priority of this service level.

Parameters:
serviceType - this flow's service type
Pre Condition:
serviceType >= 0
Post Condition:
$none

getLast

int getLast()
Gets an entity ID from the last hop that this packet has traversed.

Returns:
an entity ID
Pre Condition:
$none
Post Condition:
$none

setLast

void setLast(int last)
Sets an entity ID from the last hop that this packet has traversed.

Parameters:
last - an entity ID from the last hop
Pre Condition:
last > 0
Post Condition:
$none

getTag

int getTag()
Gets this flow tag

Returns:
this flow tag
Pre Condition:
$none
Post Condition:
$none

GridSim 5.0 beta

The University of Melbourne, Australia, 2009