MonitorRoleSimulator (Scribble::Docs::Javadoc 0.3.0.Final API)

java.lang.Object
- org.scribble.trace.model.RoleSimulator
- - org.scribble.trace.model.MonitorRoleSimulator

```
public class MonitorRoleSimulator
extends RoleSimulator
```
This abstract class represents a simulator associated with a role in a message trace.

Constructor Summary

Constructors
Constructor and Description

MonitorRoleSimulator()

Constructors
Constructor and Description
`MonitorRoleSimulator()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close(SimulatorContext context)` This method closes the role simulator.
`String`	`getModule()` This method returns the local module to be monitored.
`String`	`getProtocol()` This method returns the protocol to be monitored.
`String`	`getRole()` This method returns the role within the module to be monitored.
`void`	`init(SimulatorContext context)` This method initializes the role simulator.
`boolean`	`receive(SimulatorContext context, Message mesg, String fromRole)` This method simulates the receiving of a message.
`boolean`	`send(SimulatorContext context, Message mesg, String toRole)` This method simulates the sending of a message.
`MonitorRoleSimulator`	`setModule(String module)` This method sets the local module to be monitored.
`MonitorRoleSimulator`	`setProtocol(String protocol)` This method sets the protocol to be monitored.
`MonitorRoleSimulator`	`setRole(String role)` This method sets the role within the module to be monitored.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MonitorRoleSimulator
```
public MonitorRoleSimulator()
```
- Method Detail
  - getModule
```
public String getModule()
```
    This method returns the local module to be monitored.
    
    Returns:
    The local module
  - setModule
```
public MonitorRoleSimulator setModule(String module)
```
    This method sets the local module to be monitored.
    
    Parameters:
    module - The local module
    
    Returns:
    The simulator
  - getRole
```
public String getRole()
```
    This method returns the role within the module to be monitored.
    
    Returns:
    The role
  - setRole
```
public MonitorRoleSimulator setRole(String role)
```
    This method sets the role within the module to be monitored.
    
    Parameters:
    role - The role
    
    Returns:
    The simulator
  - getProtocol
```
public String getProtocol()
```
    This method returns the protocol to be monitored.
    
    Returns:
    The protocol
  - setProtocol
```
public MonitorRoleSimulator setProtocol(String protocol)
```
    This method sets the protocol to be monitored.
    
    Parameters:
    protocol - The protocol
    
    Returns:
    The simulator
  - init
```
public void init(SimulatorContext context)
```
    This method initializes the role simulator.
    
    Specified by:
    
    init in class RoleSimulator
    
    Parameters:
    context - The context
  - send
```
public boolean send(SimulatorContext context,
           Message mesg,
           String toRole)
```
    This method simulates the sending of a message.
    
    Specified by:
    
    send in class RoleSimulator
    
    Parameters:
    context - The context
    mesg - The message
    toRole - The target role
    
    Returns:
    Whether the send simulated as expected
  - receive
```
public boolean receive(SimulatorContext context,
              Message mesg,
              String fromRole)
```
    This method simulates the receiving of a message.
    
    Specified by:
    
    receive in class RoleSimulator
    
    Parameters:
    context - The context
    mesg - The message
    fromRole - The source role
    
    Returns:
    Whether the receive simulated as expected
  - close
```
public void close(SimulatorContext context)
```
    This method closes the role simulator.
    
    Specified by:
    
    close in class RoleSimulator
    
    Parameters:
    context - The context

Class MonitorRoleSimulator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonitorRoleSimulator

Method Detail

getModule

setModule

getRole

setRole

getProtocol

setProtocol

init

send

receive

close