org.mbari.jddac
Class RelayBlock

java.lang.Object
  extended by net.java.jddac.common.fblock.Entity
      extended by net.java.jddac.jmdi.fblock.FunctionBlock
          extended by org.mbari.jddac.RelayBlock
All Implemented Interfaces:
java.io.Serializable, net.java.jddac.common.util.ConfigurationInterface, net.java.jddac.jmdi.service.SubscriberCallback
Direct Known Subclasses:
AggregationBlock, FilterBlock, InstrumentBlock, InstrumentServiceBlock, ScatterBlock

public class RelayBlock
extends net.java.jddac.jmdi.fblock.FunctionBlock
implements java.io.Serializable

Relays results programmatically. By itself a RelayBlock does nothing. However you can associate functions with it that can carry ou specific operations.

Author:
brian
See Also:
JvmMemoryApp, Serialized Form

Field Summary
static java.lang.String OpIdAddFunction
          The OpId used to add a function.
 
Fields inherited from class net.java.jddac.jmdi.fblock.FunctionBlock
BL_ACTIVE, BL_INACTIVE, BL_UNINITIALIZED, blockMajorState, blockModelNumber, blockVersion, FB_IDLE, FB_RUNNING, FB_STOPPED, functionBlockState, groupIds, META_TEDS, OpIdClear, OpIdConfigure, OpIdGetAllMetaData, OpIdGetBlockMajorState, OpIdGetFunctionBlockState, OpIdGetGroupIDs, OpIdGetMetaData, OpIdPause, OpIdResume, OpIdStart, pubPortsProperty, subPortsProperty
 
Fields inherited from class net.java.jddac.common.fblock.Entity
description, instanceName, META_CLASS, META_NAME, META_OPERATIONS, objectProperties, OpIdGetAttribute, OpIdGetClassName, OpIdGetDescription, OpIdGetInstanceName, OpIdGetObjectProperties, OpIdGetOwningBlockObjectTag, OpIdSetAttribute, OpIdSetInstanceName, owningBlockObjectName, PerformInputArg, PerformResult
 
Constructor Summary
RelayBlock()
          Creates a new instance of RelayBlock
 
Method Summary
 boolean addChild(net.java.jddac.jmdi.fblock.FunctionBlock child)
           
 boolean addFunction(net.java.jddac.common.type.ArgArray argArray)
          A ddan IFunction to a relay block.
 net.java.jddac.jmdi.fblock.FunctionBlock[] getChildren()
           
 net.java.jddac.common.type.ArgArray perform(java.lang.String server_operation_id, net.java.jddac.common.type.ArgArray server_input_arguments)
          Performs the operation using server_input_arguments as the argument to the function used for processing
 boolean removeChild(net.java.jddac.jmdi.fblock.FunctionBlock child)
           
 
Methods inherited from class net.java.jddac.jmdi.fblock.FunctionBlock
clear, configure, destroy, destroyDeferredThread, getBlockMajorState, getBlockModelNumber, getBlockVersion, getEntityMetaData, getFunctionBlockState, getGroupIDs, getPubIDFromName, getSubIDFromName, goActive, initialize, notifySubscriber, pause, publish, publishDeferred, reset, resume, setGroupIDs, start
 
Methods inherited from class net.java.jddac.common.fblock.Entity
addOpTableMeta, getDescription, getInstanceName, getObjectProperties, getObjectPropery, getOwningBlockObjectName, setDescription, setInstanceName, setObjectProperties, setObjectProperty, setOwningBlockObjectName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OpIdAddFunction

public static final java.lang.String OpIdAddFunction
The OpId used to add a function.

See Also:
Constant Field Values
Constructor Detail

RelayBlock

public RelayBlock()
Creates a new instance of RelayBlock

Method Detail

addChild

public boolean addChild(net.java.jddac.jmdi.fblock.FunctionBlock child)

removeChild

public boolean removeChild(net.java.jddac.jmdi.fblock.FunctionBlock child)

getChildren

public net.java.jddac.jmdi.fblock.FunctionBlock[] getChildren()

perform

public net.java.jddac.common.type.ArgArray perform(java.lang.String server_operation_id,
                                                   net.java.jddac.common.type.ArgArray server_input_arguments)
                                            throws java.lang.Exception,
                                                   net.java.jddac.common.exception.OpException

Performs the operation using server_input_arguments as the argument to the function used for processing

You can set the function used by calling:

 relatyBlock.addFunction(FunctionFactory.createFunctionArg(OpIdIn, OpIdOut, new SomeIFunction());
 

Overrides:
perform in class net.java.jddac.jmdi.fblock.FunctionBlock
Throws:
java.lang.Exception
net.java.jddac.common.exception.OpException

addFunction

public boolean addFunction(net.java.jddac.common.type.ArgArray argArray)
A ddan IFunction to a relay block.

Parameters:
argArray - An ArgArray containing the needed keys-value pairs
See Also:
IFunction


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.