ITask (yartiss-engine 1.0.1 API)

All Known Implementing Classes:

AbstractTask, GraphTask, PeriodicTask, SimpleTask, SubTask
```
public interface ITask
```
Author:

Younes Chandarli

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activate(long time)` Activates a job of this task with a release time of 'time' units
`boolean`	`checkDeadlineMissed(long time)` Checks if the task missed its deadline by checking its current job at a certain instant of time
`ITask`	`cloneTask()` Duplicates the task's object
`PriorityQueue<Job>`	`getActiveJobs()` Returns the active jobs of the task
`Job`	`getCurrentJob()` Gets the current job of the task, i.e. the first job that has not been completed
`long`	`getDeadline()` Gets the relative deadline of the task
`long`	`getEnergyConsumption(long time)` Gets the energy consumption of the task if executed during a certain period of time
`IEnergyConsumptionProfile`	`getEnergyConsumptionProfile()`
`long`	`getEnergyConsumptionRate()` Gets the energy consumption rate of the task rate = wcee / wcet
`long`	`getFirstRelease()` Gets the first release time of the task
`int`	`getId()` Gets the identifier of the task
`Job`	`getLastExecutedJob()` Gets task's last executed job
`long`	`getLaxity()` Gets the laxity (slack time) of a task
`long`	`getNextAbsoluteDeadline(long time)` Gets the absolute deadline of the next job of the task
`long`	`getNextActivation(long time)` Gets the next activation time of the task
`long`	`getNextDeadline(long time, boolean nextPeriod)` Gets the absolute deadline of the current job of the task according to the value of the boolean 'nextPeriod'
`long`	`getPeriod()` Gets the relative period of the task
`long`	`getPreviousAbsoluteDeadline(long date)` Gets the absolute deadline of the previous job of the task
`int`	`getPriority()` Gets the priority of the task
`long`	`getRemainingCost()` Gets the remaining time cost of task's current job
`String`	`getType()` Gets the type of the task (simple, subtask, graph, ...)
`long`	`getWcee()` Gets the worst-case execution energy consumption of the task
`long`	`getWcet()` Gets the worst-case execution time of the task
`boolean`	`isActivationTime(long time)` Checks if a new job of task can be activated at 'time' instant of time
`boolean`	`isActive()` Checks if the task has active jobs
`boolean`	`lastExecutedJobHasCompleted()` Checks if the active job is not the last executed one
`void`	`setFirstRelease(long firstRelease)` Sets the first release time of a task
`void`	`setId(int id)` Sets an identifier to the task
`void`	`setLastExecutedJob(Job lastExecutedJob)` Sets last executed job of the task
`void`	`setPriority(int priority)` Sets the priority of the task

- Method Detail
  - getId
```
int getId()
```
    Gets the identifier of the task
    
    Returns:
    task's id
  - setId
```
void setId(int id)
```
    Sets an identifier to the task
    
    Parameters:
    id - task's identifier to be set
  - getFirstRelease
```
long getFirstRelease()
```
    Gets the first release time of the task
    
    Returns:
    task's first release time
  - setFirstRelease
```
void setFirstRelease(long firstRelease)
```
    Sets the first release time of a task
    
    Parameters:
    firstRelease - first release time
  - getWcet
```
long getWcet()
```
    Gets the worst-case execution time of the task
    
    Returns:
    task's WCET
  - getWcee
```
long getWcee()
```
    Gets the worst-case execution energy consumption of the task
    
    Returns:
    task's WCEE
  - getPeriod
```
long getPeriod()
```
    Gets the relative period of the task
    
    Returns:
    task's period
  - getDeadline
```
long getDeadline()
```
    Gets the relative deadline of the task
    
    Returns:
    task's deadline
  - getPriority
```
int getPriority()
```
    Gets the priority of the task
    
    Returns:
    task's priority
  - setPriority
```
void setPriority(int priority)
```
    Sets the priority of the task
    
    Parameters:
    priority - task's priority to be set
  - getEnergyConsumptionRate
```
long getEnergyConsumptionRate()
```
    Gets the energy consumption rate of the task rate = wcee / wcet
    
    Returns:
    task's energy consumption rate
  - getEnergyConsumption
```
long getEnergyConsumption(long time)
```
    Gets the energy consumption of the task if executed during a certain period of time
    
    Parameters:
    time - number of time's units
    
    Returns:
    task's energy consumption
  - getLaxity
```
long getLaxity()
```
    Gets the laxity (slack time) of a task
    
    Returns:
    laxity of the task
  - cloneTask
```
ITask cloneTask()
```
    Duplicates the task's object
    
    Returns:
    clones task
  - getActiveJobs
```
PriorityQueue<Job> getActiveJobs()
```
    Returns the active jobs of the task
    
    Returns:
    task's active jobs
  - isActive
```
boolean isActive()
```
    Checks if the task has active jobs
    
    Returns:
    true if there are active jobs, false otherwise
  - activate
```
void activate(long time)
```
    Activates a job of this task with a release time of 'time' units
    
    Parameters:
    time - time units
  - getCurrentJob
```
Job getCurrentJob()
```
    Gets the current job of the task, i.e. the first job that has not been completed
    
    Returns:
    task's current job
  - checkDeadlineMissed
```
boolean checkDeadlineMissed(long time)
```
    Checks if the task missed its deadline by checking its current job at a certain instant of time
    
    Parameters:
    time - time instant
    
    Returns:
    true if the task missed its deadline, false otherwise
  - lastExecutedJobHasCompleted
```
boolean lastExecutedJobHasCompleted()
```
    Checks if the active job is not the last executed one
    
    Returns:
    true if the active job is not the last executed one, false otherwise
  - getRemainingCost
```
long getRemainingCost()
```
    Gets the remaining time cost of task's current job
    
    Returns:
    task's remaining time cost
  - getNextDeadline
```
long getNextDeadline(long time,
                   boolean nextPeriod)
```
    Gets the absolute deadline of the current job of the task according to the value of the boolean 'nextPeriod'
    
    Parameters:
    time - current instant of time
    nextPeriod - if true, next period of the task is calculated. If false, current period is calculated
    
    Returns:
    task's next deadline
  - getNextActivation
```
long getNextActivation(long time)
```
    Gets the next activation time of the task
    
    Parameters:
    time - current time
    
    Returns:
    task's next activation time
  - isActivationTime
```
boolean isActivationTime(long time)
```
    Checks if a new job of task can be activated at 'time' instant of time
    
    Parameters:
    time - current time
    
    Returns:
    true if it is activation time, false otherwise
  - getNextAbsoluteDeadline
```
long getNextAbsoluteDeadline(long time)
```
    Gets the absolute deadline of the next job of the task
    
    Parameters:
    time - current instant of time
    
    Returns:
    task's next absolute deadline
  - getPreviousAbsoluteDeadline
```
long getPreviousAbsoluteDeadline(long date)
```
    Gets the absolute deadline of the previous job of the task
    
    Parameters:
    time - current instant of time
    
    Returns:
    task's previous absolute deadline
  - getLastExecutedJob
```
Job getLastExecutedJob()
```
    Gets task's last executed job
    
    Returns:
    last executed job
  - setLastExecutedJob
```
void setLastExecutedJob(Job lastExecutedJob)
```
    Sets last executed job of the task
    
    Parameters:
    lastExecutedJob - the last executed job to set
  - getType
```
String getType()
```
    Gets the type of the task (simple, subtask, graph, ...)
    
    Returns:
    task's type
  - getEnergyConsumptionProfile
```
IEnergyConsumptionProfile getEnergyConsumptionProfile()
```

Interface ITask

Method Summary

Method Detail

getId

setId

getFirstRelease

setFirstRelease

getWcet

getWcee

getPeriod

getDeadline

getPriority

setPriority

getEnergyConsumptionRate

getEnergyConsumption

getLaxity

cloneTask

getActiveJobs

isActive

activate

getCurrentJob

checkDeadlineMissed

lastExecutedJobHasCompleted

getRemainingCost

getNextDeadline

getNextActivation

isActivationTime

getNextAbsoluteDeadline

getPreviousAbsoluteDeadline

getLastExecutedJob

setLastExecutedJob

getType

getEnergyConsumptionProfile