drcl.comp.queue
Class QueueFIFO

java.lang.Object
  drcl.DrclObj
      drcl.comp.Component
          drcl.comp.queue.ActiveQueue
              drcl.comp.queue.QueueFIFO

All Implemented Interfaces:

java.lang.Cloneable, ObjectDuplicable, java.io.Serializable

public class QueueFIFO

extends ActiveQueue

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class drcl.comp.Component

Component.Locks

Field Summary

Fields inherited from class drcl.comp.queue.ActiveQueue

nrequests, outport, OUTPUT_PORT_ID

Fields inherited from class drcl.comp.Component

FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_EXPOSED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_HAS_EXPOSED_CHILD, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND

Constructor Summary

QueueFIFO()

QueueFIFO(java.lang.String id_)

Method Summary

java.lang.Object	dequeue() Dequeues and returns the first object in the queue.
void	duplicate(java.lang.Object source_) Duplicates the content of source_, including ID, name, child components and connections among them, to this component.
java.lang.Object	enqueue(java.lang.Object obj_) Enqueues the object at the end of the queue
java.lang.Object	enqueueAt(java.lang.Object obj_, int pos_) Enqueues the object at the position specified.
int	getCapacity() Returns the capacity of the queue.
int	getSize() Returns the current size of the queue.
java.lang.String	info(java.lang.String prefix_)
boolean	isEmpty() Return true if the queue is empty.
boolean	isFull() Return true if the queue is full.
java.lang.Object	peekAt(int pos_) Retrieves but not dequeue the object at the position specified.
void	reset() Resets the component for being used anew.
java.lang.Object	retrieveAt(int pos_) Dequeues the object at the position specified.
void	setCapacity(int capacity_) Sets the capacity of the queue.

Methods inherited from class drcl.comp.queue.ActiveQueue

_getnrequests, _setnrequests, firstElement, getAvailableSize, getEnqueCount, increaseEnqueCount, info, lastElement, process, pull

Methods inherited from class drcl.comp.Component

_resume, _start, _stop, addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, componentAdded, componentRemoved, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, finishing, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getForkManager, getID, getName, getParent, getPort, getPort, getRoot, getRuntime, getTime, iduplicate, isAncestorOf, isComponentNotificationEnabled, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortNotificationEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, portAdded, portRemoved, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setComponentNotificationEnabled, setContract, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setPortNotificationEnabled, setPortRemovable, setRuntime, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait, yield

Methods inherited from class drcl.DrclObj

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueFIFO

public QueueFIFO()

QueueFIFO

public QueueFIFO(java.lang.String id_)

Method Detail

reset

public void reset()

Description copied from class: Component

Resets the component for being used anew. All the internal variables must be set to the initial state. All the ports and child components are reset as well.

Overrides:

reset in class ActiveQueue

duplicate

public void duplicate(java.lang.Object source_)

Description copied from class: Component

Duplicates the content of source_, including ID, name, child components and connections among them, to this component. Subclasses need to override this method to copy its own variables.

Specified by:

duplicate in interface ObjectDuplicable

Overrides:

duplicate in class Component

info

public java.lang.String info(java.lang.String prefix_)

Overrides:

info in class ActiveQueue

enqueue

public java.lang.Object enqueue(java.lang.Object obj_)

Enqueues the object at the end of the queue

Specified by:

enqueue in class ActiveQueue

Returns:

the object being dropped due to the enqueue; null otherwise.

enqueueAt

public java.lang.Object enqueueAt(java.lang.Object obj_,
                                  int pos_)

Enqueues the object at the position specified.

Overrides:

enqueueAt in class ActiveQueue

Returns:

the object being dropped due to the enqueue; null otherwise.

dequeue

public java.lang.Object dequeue()

Dequeues and returns the first object in the queue.

Specified by:

dequeue in class ActiveQueue

Returns:

the object dequeued; null if position is not valid.

retrieveAt

public java.lang.Object retrieveAt(int pos_)

Dequeues the object at the position specified.

Overrides:

retrieveAt in class ActiveQueue

Returns:

the object dequeued; null if position is not valid.

peekAt

public java.lang.Object peekAt(int pos_)

Retrieves but not dequeue the object at the position specified.

Overrides:

peekAt in class ActiveQueue

Returns:

the object; null if position is not valid.

isFull

public boolean isFull()

Return true if the queue is full.

Specified by:

isFull in class ActiveQueue

isEmpty

public boolean isEmpty()

Return true if the queue is empty.

Specified by:

isEmpty in class ActiveQueue

setCapacity

public void setCapacity(int capacity_)

Sets the capacity of the queue.

Specified by:

setCapacity in class ActiveQueue

Parameters:

capacity_ - the new capacity.

getCapacity

public int getCapacity()

Returns the capacity of the queue.

Specified by:

getCapacity in class ActiveQueue

getSize

public int getSize()

Returns the current size of the queue.

Specified by:

getSize in class ActiveQueue