Package cmion.level2.competencies

Class ExampleCompetency

java.lang.Object

ion.Meta.Element

cmion.architecture.CmionComponent

cmion.level2.Competency

cmion.level2.competencies.ExampleCompetency

All Implemented Interfaces:

java.lang.Runnable

public class ExampleCompetency
extends Competency

example of the implementation of a competency, with comments explaining how to define competencies, this is not actually doing anything serious

Field Summary

Fields inherited from class cmion.architecture.CmionComponent

architecture

Fields inherited from class cmion.level2.Competency

available, competencyName, competencyType, plan, running

Constructor Summary

Constructors

Constructor	Description
ExampleCompetency(IArchitecture architecture)	constructor, every competency, should if possible have a constructor that receives the Architecture as an argument

Method Summary

Modifier and Type	Method	Description
protected boolean	competencyCode(java.util.HashMap<java.lang.String,java.lang.String> parameters)	the custom code of the competence, this is already running in a thread
void	initialize()	perform initialisations in this method
boolean	runsInBackground()	this competency is invoked directly (does not run in background)

Methods inherited from class cmion.architecture.CmionComponent

getArchitecture, isConnected, onDestroy, raise

Methods inherited from class cmion.level2.Competency

cancel, getCompetencyName, getCompetencyType, isAvailable, isRunning, registerHandlers, requestStartCompetency, run, setAdditionalData

Methods inherited from class ion.Meta.Element

destroy, getEventFilters, getEventHandlers, getRequestFilters, getRequestHandlers, getSimulation, getUID, schedule, wasDestroyed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExampleCompetency

public ExampleCompetency(IArchitecture architecture)

constructor, every competency, should if possible have a constructor that receives the Architecture as an argument

Method Detail

initialize

public void initialize()

perform initialisations in this method

Specified by:

initialize in class Competency

runsInBackground

public boolean runsInBackground()

this competency is invoked directly (does not run in background)

Specified by:

runsInBackground in class Competency

competencyCode

protected boolean competencyCode(java.util.HashMap<java.lang.String,java.lang.String> parameters)

the custom code of the competence, this is already running in a thread

Specified by:

competencyCode in class Competency

Parameters:

parameters - a map including running parameters and their values

Returns:

the return value of this method should indicate, whether the competency execution was a success (true) or failure (false)