SystemInfluence (SIMILAR API suite 1.0-SNAPSHOT API)

java.lang.Object
- fr.univ_artois.lgi2a.similar.microkernel.influences.AbstractInfluence
- - fr.univ_artois.lgi2a.similar.microkernel.influences.SystemInfluence

All Implemented Interfaces:

IInfluence

Direct Known Subclasses:

SystemInfluenceAddAgent, SystemInfluenceAddAgentToLevel, SystemInfluenceRemoveAgent, SystemInfluenceRemoveAgentFromLevel
```
public class SystemInfluence
extends AbstractInfluence
```
Models a system influence that has to be managed at least by the simulation engine of the simulation.

Author:

Yoann Kubera

Constructor Summary

Constructors
Constructor	Description
`SystemInfluence(String category, LevelIdentifier targetLevel, SimulationTimeStamp timeLowerBound, SimulationTimeStamp timeUpperBound)`	Builds a system influence from a specific category.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean isSystem()
Returns true, since this influence is a system influence.
- Methods inherited from class fr.univ_artois.lgi2a.similar.microkernel.influences.AbstractInfluence
  getCategory, getTargetLevel, getTimeLowerBound, getTimeUpperBound, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SystemInfluence
```
public SystemInfluence(String category,
                       LevelIdentifier targetLevel,
                       SimulationTimeStamp timeLowerBound,
                       SimulationTimeStamp timeUpperBound)
```
    Builds a system influence from a specific category. The reaction to this influence will be managed into a specific target level.
    
    Parameters:
    
    category - The category of the influence, as described in IInfluence.getCategory()
    
    targetLevel - The target level of the influence, as described in IInfluence.getTargetLevel()
    
    timeLowerBound - The lower bound of the transitory period during which this influence was created.
    
    timeUpperBound - The upper bound of the transitory period during which this influence was created.
    
    Throws:
    
    IllegalArgumentException - If one of the arguments is null.
- Method Detail
  - isSystem
```
public boolean isSystem()
```
    Returns true, since this influence is a system influence.
    
    Returns:
    
    true if the influence is a system influence.