Package topo :: Package base :: Module simulation :: Class EPConnection
[hide private]
[frames] | no frames]

Class EPConnection

source code

                       object --+    
                                |    
param.parameterized.Parameterized --+
                                    |
                                   EPConnection
Known Subclasses:

EPConnection stores basic information for a connection between two EventProcessors.
Nested Classes [hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods [hide private]
 
remove(self)
Remove this connection from its src's list of out_connections and its dest's list of in_connections.
source code
 
script_repr(self, imports=[], prefix=' ')
Generate a runnable command for creating this connection.
source code

Inherited from param.parameterized.Parameterized: __getstate__, __init__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, set_dynamic_time_fn, state_pop, state_push, verbose, warning

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Class Methods [hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables [hide private]
  src = param.Parameter(default= None, constant= True, precedenc...
The EventProcessor from which messages originate.
  dest = param.Parameter(default= None, constant= True, preceden...
The EventProcessor to which messages are delivered.
  src_port = param.Parameter(default= None, precedence= 0.20, do...
Identifier that can be used to distinguish different types of outgoing connections.
  dest_port = param.Parameter(default= None, precedence= 0.21, d...
Identifier that can be used to distinguish different types of incoming connections.
  delay = param.Number(default= 0, doc= """Simulation time betwe...
Simulation time between when each Event is generated by the src and when it is delivered to the dest.
  private = param.Boolean(default= False, doc= """Set to true if...
Set to true if this connection is for internal use only, not to be manipulated by a user.

Inherited from param.parameterized.Parameterized: name, print_level

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

script_repr(self, imports=[], prefix=' ')

source code 
Generate a runnable command for creating this connection.
Overrides: param.parameterized.Parameterized.script_repr

Class Variable Details [hide private]

src

The EventProcessor from which messages originate.
Value:
param.Parameter(default= None, constant= True, precedence= 0.10, doc= """The Event\
Processor from which messages originate.""")

dest

The EventProcessor to which messages are delivered.
Value:
param.Parameter(default= None, constant= True, precedence= 0.11, doc= """The Event\
Processor to which messages are delivered.""")

src_port

Identifier that can be used to distinguish different types of outgoing connections.

EventProcessors that generate only a single type of outgoing event will typically use a src_port of None. However, if multiple types of communication are meaningful, the EventProcessor can accept other values for src_port. It is up to the src EventProcessor to deliver appropriate data to each port, and to declare what will be sent over that port.

Value:
param.Parameter(default= None, precedence= 0.20, doc= """
       Identifier that can be used to distinguish different types of outgoing conn\
ections.

       EventProcessors that generate only a single type of
       outgoing event will typically use a src_port of None.  However,
       if multiple types of communication are meaningful, the
       EventProcessor can accept other values for src_port.  It is up
...

dest_port

Identifier that can be used to distinguish different types of incoming connections.

EventProcessors that accept only a single type of incoming event will typically use a src_port of None. However, if multiple types are of communication are meaningful, the EventProcessor can accept other values for dest_port. It is up to the dest EventProcessor to process the data appropriately for each port, and to define what is expected to be sent to that port.

Value:
param.Parameter(default= None, precedence= 0.21, doc= """
       Identifier that can be used to distinguish different types of incoming conn\
ections.

       EventProcessors that accept only a single type of incoming
       event will typically use a src_port of None.  However, if
       multiple types are of communication are meaningful, the
       EventProcessor can accept other values for dest_port.  It is up
...

delay

Simulation time between when each Event is generated by the src and when it is delivered to the dest.
Value:
param.Number(default= 0, doc= """Simulation time between when each Event is genera\
ted by the src and when it is delivered to the dest.""")

private

Set to true if this connection is for internal use only, not to be manipulated by a user.
Value:
param.Boolean(default= False, doc= """Set to true if this connection is for intern\
al use only, not to be manipulated by a user.""")