org.mbari.jddac
Class ScatterBlock

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
              extended by org.mbari.jddac.ScatterBlock
All Implemented Interfaces:
java.io.Serializable, net.java.jddac.common.util.ConfigurationInterface, net.java.jddac.jmdi.service.SubscriberCallback

public class ScatterBlock
extends RelayBlock

Pulls out each value out of an argArray and passes them separatly to any child functions. Note: You can not add functions to this block

Author:
brian
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mbari.jddac.RelayBlock
OpIdAddFunction
 
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
ScatterBlock()
          Creates a new instance of ScatterBlock
 
Method Summary
 boolean addFunction(net.java.jddac.common.type.ArgArray argArray)
          A ddan IFunction to a relay block.
 net.java.jddac.common.type.ArgArray perform(java.lang.String server_operation_id, net.java.jddac.common.type.ArgArray server_input_arguments)
          Passes each ArgArray value with in the ArgArray argument to each child FunctionBlock seperatly using the same server_operation_id For Example:
 
Methods inherited from class org.mbari.jddac.RelayBlock
addChild, getChildren, removeChild
 
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
 

Constructor Detail

ScatterBlock

public ScatterBlock()
Creates a new instance of ScatterBlock

Method Detail

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
Passes each ArgArray value with in the ArgArray argument to each child FunctionBlock seperatly using the same server_operation_id For Example:
 ArgArray {
 "nameA": ArgArray {
           "name1": Measurement
           "name2": Measurement
           ...
         }
"nameB": ArgArray {
           "name3": Measurement
           "name4": Measurement
           ...
         }
 }

 This block passes these values to each child function it to:
 ArgArray {
   "name1": Measurement
   "name2": Measurement
   ...
 }

ArgArray {
   "name3": Measurement
   "name4": Measurement
   ...
 }
   
 

Overrides:
perform in class RelayBlock
Throws:
java.lang.Exception
net.java.jddac.common.exception.OpException

addFunction

public boolean addFunction(net.java.jddac.common.type.ArgArray argArray)
Description copied from class: RelayBlock
A ddan IFunction to a relay block.

Overrides:
addFunction in class RelayBlock
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.