ensemble.memory

Class Memory

java.lang.Object

ensemble.memory.Memory

All Implemented Interfaces:

LifeCycle

Direct Known Subclasses:

AudioMemory, EventMemory, MultichannelAudioMemory

public abstract class Memory
extends java.lang.Object
implements LifeCycle

The Class Memory.

Field Summary

Fields

Modifier and Type	Field and Description
protected VirtualClockHelper	clock The clock.
protected double	future The future.
protected EnsembleAgent	myAgent The my agent.
protected java.lang.String	name The name.
protected Parameters	parameters The parameters.
protected double	past The past.

Constructor Summary

Constructors

Constructor and Description
Memory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
boolean	finit() User-implemented finalization method, called by stop().
abstract double	getFirstInstant() Retorna o instante mais antigo em que existe informação na memória.
double	getFuture() Gets the future.
abstract double	getLastInstant() Retorna o último instante em que existe informação na memória.
java.lang.String	getName() Retorna o nome do componente ao qual está memória está associada.
Parameters	getParameters() Returns all configured parameters.
double	getPast() Gets the past.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
abstract java.lang.Object	readMemory(double instant, double duration, TimeUnit unit) Obtém a memória em um dado intervalo de tempo.
abstract java.lang.Object	readMemory(double instant, TimeUnit unit) Obtém a memória em um instante do tempo.
abstract void	resetMemory() Limpa a memória.
void	setAgent(EnsembleAgent myAgent) Sets the agent.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
boolean	start() Framework-implemented initialization method.
boolean	stop() Framework-implemented finalization method.
abstract void	writeMemory(java.lang.Object object) Write memory.
abstract void	writeMemory(java.lang.Object object, double instant, double duration, TimeUnit unit) Escreve na memória a partir de um instante absoluto.
abstract void	writeMemory(java.lang.Object object, double instant, TimeUnit unit) Write memory.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected Parameters parameters

The parameters.

clock

protected VirtualClockHelper clock

The clock.

myAgent

protected EnsembleAgent myAgent

The my agent.

name

protected java.lang.String name

The name.

past

protected double past

The past.

future

protected double future

The future.

Constructor Detail

Memory

public Memory()

Method Detail

getParameters

public Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

setParameters

public void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

setAgent

public void setAgent(EnsembleAgent myAgent)

Sets the agent.

Parameters:

myAgent - the new agent

start

public boolean start()

Description copied from interface: LifeCycle

Framework-implemented initialization method.

Specified by:

start in interface LifeCycle

Returns:

true, if successful

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

stop

public boolean stop()

Description copied from interface: LifeCycle

Framework-implemented finalization method.

Specified by:

stop in interface LifeCycle

Returns:

true, if successful

configure

public boolean configure()

Description copied from interface: LifeCycle

User-implemented method that configures the component, setting up user parameters and essential properties.

Specified by:

configure in interface LifeCycle

Returns:

true, if successful

init

public boolean init()

Description copied from interface: LifeCycle

User-implemented initialization method, called by start().

Specified by:

init in interface LifeCycle

Returns:

true, if successful

finit

public boolean finit()

Description copied from interface: LifeCycle

User-implemented finalization method, called by stop().

Specified by:

finit in interface LifeCycle

Returns:

true, if successful

getName

public final java.lang.String getName()

Retorna o nome do componente ao qual está memória está associada.

Returns:

the name

getPast

public final double getPast()

Gets the past.

Returns:

the past

getFuture

public final double getFuture()

Gets the future.

Returns:

the future

getFirstInstant

public abstract double getFirstInstant()

Retorna o instante mais antigo em que existe informação na memória.

Returns:

the first instant

getLastInstant

public abstract double getLastInstant()

Retorna o último instante em que existe informação na memória.

Returns:

the last instant

readMemory

public abstract java.lang.Object readMemory(double instant,
                          TimeUnit unit)

Obtém a memória em um instante do tempo.

Parameters:

instant - the instant

unit - the unit

Returns:

the object

readMemory

public abstract java.lang.Object readMemory(double instant,
                          double duration,
                          TimeUnit unit)

Obtém a memória em um dado intervalo de tempo.

Parameters:

instant - the instant

duration - the duration

unit - the unit

Returns:

the object

resetMemory

public abstract void resetMemory()

Limpa a memória.

writeMemory

public abstract void writeMemory(java.lang.Object object,
               double instant,
               double duration,
               TimeUnit unit)
                          throws MemoryException

Escreve na memória a partir de um instante absoluto.

Parameters:

object - the object

instant - the instant

duration - the duration

unit - the unit

Throws:

MemoryException - the memory exception

writeMemory

public abstract void writeMemory(java.lang.Object object,
               double instant,
               TimeUnit unit)
                          throws MemoryException

Write memory.

Parameters:

object - the object

instant - the instant

unit - the unit

Throws:

MemoryException - the memory exception

writeMemory

public abstract void writeMemory(java.lang.Object object)
                          throws MemoryException

Write memory.

Parameters:

object - the object

Throws:

MemoryException - the memory exception