jadex.bridge

Interface IComponentDescription

public interface IComponentDescription

A description of a component, i.e. information about the execution state, component type, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROCESSINGSTATE_IDLE The idle processing state.
static String	PROCESSINGSTATE_READY The ready processing state.
static String	PROCESSINGSTATE_RUNNING The running processing state.
static String	STATE_ACTIVE Predefined value "active" for slot state.
static String	STATE_INITIATED Predefined value "initiated" for slot state.
static String	STATE_SUSPENDED Predefined value "suspended" for slot state.
static String	STATE_TERMINATED Predefined value "terminated" for slot state.
static String	STATE_TRANSIT Predefined value "transit" for slot state.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAutoShutdown() Get the auto shutdown flag.
String[]	getBreakpoints() Get the enabled breakpoints (if any).
Boolean	getDaemon() Is the component a daemon.
String	getLocalType() Get the local type name of a component (defined in the parent).
Boolean	getMaster() Is the component a master.
String	getModelName() Get the model name.
IComponentIdentifier	getName() Get the identifier of the component.
String	getOwnership() Get the ownership string of the component.
String	getState() Get the execution state of the component.
String	getType() Get the component type.

Field Detail

STATE_INITIATED

static final String STATE_INITIATED

Predefined value "initiated" for slot state.

See Also:

Constant Field Values

STATE_TRANSIT

static final String STATE_TRANSIT

Predefined value "transit" for slot state.

See Also:

Constant Field Values

STATE_ACTIVE

static final String STATE_ACTIVE

Predefined value "active" for slot state.

See Also:

Constant Field Values

STATE_SUSPENDED

static final String STATE_SUSPENDED

Predefined value "suspended" for slot state.

See Also:

Constant Field Values

STATE_TERMINATED

static final String STATE_TERMINATED

Predefined value "terminated" for slot state.

See Also:

Constant Field Values

PROCESSINGSTATE_READY

static final String PROCESSINGSTATE_READY

The ready processing state.

See Also:

Constant Field Values

PROCESSINGSTATE_RUNNING

static final String PROCESSINGSTATE_RUNNING

The running processing state.

See Also:

Constant Field Values

PROCESSINGSTATE_IDLE

static final String PROCESSINGSTATE_IDLE

The idle processing state.

See Also:

Constant Field Values

Method Detail

getName

IComponentIdentifier getName()

Get the identifier of the component.

Returns:

The component identifier.

getModelName

String getModelName()

Get the model name.

Returns:

The model name.

getOwnership

String getOwnership()

Get the ownership string of the component.

Returns:

The ownership string.

getType

String getType()

Get the component type.

Returns:

The component type name (e.g. 'BDI Agent').

getState

String getState()

Get the execution state of the component. E.g. active or suspended.

Returns:

The state.

getBreakpoints

String[] getBreakpoints()

Get the enabled breakpoints (if any).

Returns:

The enabled breakpoints.

getMaster

Boolean getMaster()

Is the component a master. When a master component is killed the parent component will be killed two.

Returns:

True, if master component.

getDaemon

Boolean getDaemon()

Is the component a daemon. When platform is in autoshutdown mode and the last non-daemon component is killed the platform will also be shutdowned.

Returns:

True, if daemon component.

getAutoShutdown

Boolean getAutoShutdown()

Get the auto shutdown flag.

Returns:

The flag.

getLocalType

String getLocalType()

Get the local type name of a component (defined in the parent).

Returns:

The local type.