at.lcm.x2c.scilab.xcos.xcosAdapter
Class XcosAdapter_Block

java.lang.Object
  extended by at.lcm.x2c.scilab.xcos.xcosAdapter.XcosAdapter_Block

public class XcosAdapter_Block
extends java.lang.Object

XcosAdapterBasic_Block is an adapter to Xcos BasicBlock.

Author:
Martin Hochwallner, Markus Aigner

Constructor Summary
XcosAdapter_Block(org.scilab.modules.xcos.block.BasicBlock xcosBlock)
           
 
Method Summary
 java.lang.Integer acquireSampleTimeFactor()
          Acquire the SampleTimeFactor by walking the xcos model to find the clock
 XcosAdapter_Block getControlingBlock()
           
 org.scilab.modules.xcos.port.command.CommandPort getControlingPort()
           
 org.scilab.modules.xcos.link.commandcontrol.CommandControlLink getControlLink()
           
 org.scilab.modules.xcos.port.control.ControlPort getControlPort()
           
 java.util.List<org.scilab.modules.xcos.port.control.ControlPort> getControlPorts()
           
 XcosExprs getExprs()
           
 java.lang.String getID()
          Return the Id of the xcos block
 org.scilab.modules.xcos.port.input.ExplicitInputPort getInPort(java.lang.String portName)
           
 org.scilab.modules.xcos.port.input.InputPort getInputPort()
          Returns input port.
 java.util.List<org.scilab.modules.xcos.port.input.InputPort> getInputPorts()
          Returns input port list.
 java.lang.String getInterfaceFunctionName()
           
 org.scilab.modules.xcos.port.output.OutputPort getOutputPort()
          Returns output port.
 java.util.List<org.scilab.modules.xcos.port.output.OutputPort> getOutputPorts()
          Returns output port list.
 java.lang.Integer getSampleTimeFactor()
           
 org.scilab.modules.xcos.port.output.ExplicitOutputPort getSourceOfInPort(org.scilab.modules.xcos.port.input.InputPort port)
          Returns source of input port.
 org.scilab.modules.xcos.port.output.ExplicitOutputPort getSourceOfInPort(java.lang.String portName)
          Returns source of input port.
 java.lang.String getX2cBlockLabel()
           
 java.lang.String getX2cBlockLabelFull()
           
 java.lang.String getX2cBlockName()
          Returns X2C block name.
 java.lang.String getX2cLibName()
          Returns X2C library name.
 org.scilab.modules.xcos.block.BasicBlock getXcosBlock()
           
 java.lang.String getXcosBlockLabel()
           
 XcosAdapter_Block getXcosClock()
           
 boolean isCurrentModel(java.lang.String modelIdentification)
           
 boolean isX2cBlock()
          Checks whether BasicBlock is a X2C block.
 void renameBlock(java.lang.String blockLabel_new, java.lang.String blockLabelFull_new)
           
 void setModelIdentification(java.lang.String modelIdentification)
           
 void setSampleTimeFactor(java.lang.Integer sampleTimeFactor)
           
 java.lang.String toString()
           
 void updateBlockExprs()
           
 void updateModelIdentification(java.lang.String modelIdentification)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XcosAdapter_Block

public XcosAdapter_Block(org.scilab.modules.xcos.block.BasicBlock xcosBlock)
                  throws java.lang.Exception
Throws:
java.lang.Exception
Method Detail

getXcosBlock

public org.scilab.modules.xcos.block.BasicBlock getXcosBlock()
Returns:
the xcosBlock

getControlPorts

public java.util.List<org.scilab.modules.xcos.port.control.ControlPort> getControlPorts()

getControlPort

public org.scilab.modules.xcos.port.control.ControlPort getControlPort()
                                                                throws java.lang.Exception
Throws:
java.lang.Exception

getControlLink

public org.scilab.modules.xcos.link.commandcontrol.CommandControlLink getControlLink()
                                                                              throws java.lang.Exception
Throws:
java.lang.Exception

getControlingBlock

public XcosAdapter_Block getControlingBlock()
                                     throws java.lang.Exception
Throws:
java.lang.Exception

getControlingPort

public org.scilab.modules.xcos.port.command.CommandPort getControlingPort()
                                                                   throws java.lang.Exception
Throws:
java.lang.Exception

getInputPorts

public java.util.List<org.scilab.modules.xcos.port.input.InputPort> getInputPorts()
Returns input port list.

Returns:
Input port list

getInputPort

public org.scilab.modules.xcos.port.input.InputPort getInputPort()
                                                          throws java.lang.Exception
Returns input port.

Returns:
Input port
Throws:
java.lang.Exception

getOutputPorts

public java.util.List<org.scilab.modules.xcos.port.output.OutputPort> getOutputPorts()
Returns output port list.

Returns:
Output port list

getOutputPort

public org.scilab.modules.xcos.port.output.OutputPort getOutputPort()
                                                             throws java.lang.Exception
Returns output port.

Returns:
Output port
Throws:
java.lang.Exception

getInterfaceFunctionName

public java.lang.String getInterfaceFunctionName()

isX2cBlock

public boolean isX2cBlock()
                   throws java.lang.Exception
Checks whether BasicBlock is a X2C block.

Returns:
true if block is a X2C block
Throws:
java.lang.Exception

getX2cLibName

public java.lang.String getX2cLibName()
                               throws java.lang.Exception
Returns X2C library name.

Returns:
X2C library name
Throws:
java.lang.Exception

getX2cBlockName

public java.lang.String getX2cBlockName()
                                 throws java.lang.Exception
Returns X2C block name.

Returns:
X2C block name
Throws:
java.lang.Exception

getX2cBlockLabel

public java.lang.String getX2cBlockLabel()
                                  throws java.lang.Exception
Throws:
java.lang.Exception

getX2cBlockLabelFull

public java.lang.String getX2cBlockLabelFull()
                                      throws java.lang.Exception
Throws:
java.lang.Exception

getInPort

public org.scilab.modules.xcos.port.input.ExplicitInputPort getInPort(java.lang.String portName)
                                                               throws java.lang.Exception
Throws:
java.lang.Exception

getSourceOfInPort

public org.scilab.modules.xcos.port.output.ExplicitOutputPort getSourceOfInPort(java.lang.String portName)
                                                                         throws java.lang.Exception
Returns source of input port.

Parameters:
portName - Input port name
Returns:
Source of input port
Throws:
java.lang.Exception

getSourceOfInPort

public org.scilab.modules.xcos.port.output.ExplicitOutputPort getSourceOfInPort(org.scilab.modules.xcos.port.input.InputPort port)
                                                                         throws java.lang.Exception
Returns source of input port.

Parameters:
port - Input port
Returns:
Source of input port
Throws:
java.lang.Exception

acquireSampleTimeFactor

public java.lang.Integer acquireSampleTimeFactor()
                                          throws java.lang.Exception
Acquire the SampleTimeFactor by walking the xcos model to find the clock

Returns:
sampleTimeFactor or null
Throws:
java.lang.Exception

setSampleTimeFactor

public void setSampleTimeFactor(java.lang.Integer sampleTimeFactor)

getSampleTimeFactor

public java.lang.Integer getSampleTimeFactor()

getXcosClock

public XcosAdapter_Block getXcosClock()
                               throws java.lang.Exception
Throws:
java.lang.Exception

renameBlock

public void renameBlock(java.lang.String blockLabel_new,
                        java.lang.String blockLabelFull_new)
                 throws java.lang.Exception
Throws:
java.lang.Exception

getXcosBlockLabel

public java.lang.String getXcosBlockLabel()

setModelIdentification

public void setModelIdentification(java.lang.String modelIdentification)

updateModelIdentification

public void updateModelIdentification(java.lang.String modelIdentification)
                               throws java.lang.Exception
Throws:
java.lang.Exception

isCurrentModel

public boolean isCurrentModel(java.lang.String modelIdentification)

getExprs

public XcosExprs getExprs()

updateBlockExprs

public void updateBlockExprs()

getID

public java.lang.String getID()
Return the Id of the xcos block

Returns:
the Id of the xcos block

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright 2013 LCM. All rights reserved.