Package com.piketec.tpt.api.steplist

Interface TableStep

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, Step, TptRemote

public interface TableStep
extends Step

The TableStep is a step which provides the possibility to manage and execute similar wait blocks in a compressed way. Abstractly, a TableStep consists of some usual columns and a single (unusual) wait column. The usual columns will be, dependent to their TableStep.TableStepColumnType, executed as long there is enough time left. The time limit is defined by the wait column. Then the next row will be executed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TableStep.TableStepColumnType	A table step column can apply the (check-,set-,call-)-rules.

Field Summary

Fields inherited from interface com.piketec.tpt.api.steplist.Step

CALL_FUNCTION, CHANNEL, COMPARE, DOCUMENTATION, ELSE, ELSE_IF_EXPRESSION, ELSE_IF_VALUE, EMBEDDED_SIGNAL, END, IF_EXPRESSION, IF_VALUE, IMPORT_SIGNAL, MESSAGE_BOX, PARALLEL, PARAMETER, RAMP, RESET_ALL_PARAMETERS, RESET_PARAMETER, RESET_TARGET, TABLE, TESTLET, WAIT, WAIT_EXPRESSION, WAIT_FOR_VALUE, WHILE_EXPRESSION

Method Summary

Modifier and Type	Method	Description
void	addColumn(int index)	Adds a new column at index.
void	addRow(int index)	Adds a new row at index.
int	getColumnCount()
TableStep.TableStepColumnType	getColumnType(int columnIndex)
java.lang.String	getDeclarationName(int columnIndex)
int	getRowCount()
java.lang.String	getValueAt(int rowIndex, int columnIndex)
java.lang.String	getWaitExpr(int rowIndex)
void	removeColumn(int index)	Removes the column at index.
void	removeRow(int index)	Removes the row at index.
void	setColumnType(int columnIndex, TableStep.TableStepColumnType type)	Sets the TableStep.TableStepColumnType of the column at position columnPos.
void	setDeclarationName(int columnIndex, java.lang.String name)	Sets the declaration of the columnPosth column by their name.
void	setValueAt(int rowIndex, int columnIndex, java.lang.String value)	Sets the value of a cell in the table.
void	setWaitExpr(int rowIndex, java.lang.String expr)	Set the time to wait after the row is executed.

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Methods inherited from interface com.piketec.tpt.api.steplist.Step

getDocumentation, getProperties, getStepList, getType, isActive, setActive, setDocumentation, setProperties

Method Detail

getColumnType

TableStep.TableStepColumnType getColumnType(int columnIndex)
                                     throws java.rmi.RemoteException

Parameters:

columnIndex - column index

Returns:

the TableStep.TableStepColumnType of the columnPosth column.

Throws:

java.rmi.RemoteException - remote communication problem

setColumnType

void setColumnType(int columnIndex,
                   TableStep.TableStepColumnType type)
            throws java.rmi.RemoteException

Sets the TableStep.TableStepColumnType of the column at position columnPos.

Parameters:

columnIndex - column index

type - type of this column

Throws:

java.rmi.RemoteException - remote communication problem

getDeclarationName

java.lang.String getDeclarationName(int columnIndex)
                             throws java.rmi.RemoteException

Parameters:

columnIndex - column index

Returns:

the declaration name of the columnPosth column.

Throws:

java.rmi.RemoteException - remote communication problem

setDeclarationName

void setDeclarationName(int columnIndex,
                        java.lang.String name)
                 throws java.rmi.RemoteException

Sets the declaration of the columnPosth column by their name.

Parameters:

columnIndex - column index

name - name of the channel/parameter/measurement/assessment to set/check in this column

Throws:

java.rmi.RemoteException - remote communication problem

getWaitExpr

java.lang.String getWaitExpr(int rowIndex)
                      throws java.rmi.RemoteException

Parameters:

rowIndex - row index

Returns:

the time to wait after the row is executed.

Throws:

java.rmi.RemoteException - remote communication problem

setWaitExpr

void setWaitExpr(int rowIndex,
                 java.lang.String expr)
          throws java.rmi.RemoteException

Set the time to wait after the row is executed.

Parameters:

rowIndex - row index

expr - expression to use as wait condition in this row

Throws:

java.rmi.RemoteException - remote communication problem

getValueAt

java.lang.String getValueAt(int rowIndex,
                            int columnIndex)
                     throws java.rmi.RemoteException

Parameters:

rowIndex - row index

columnIndex - column index

Returns:

the value of an cell in the table.

Throws:

java.rmi.RemoteException - remote communication problem

setValueAt

void setValueAt(int rowIndex,
                int columnIndex,
                java.lang.String value)
         throws java.rmi.RemoteException

Sets the value of a cell in the table.

Parameters:

rowIndex - row index

columnIndex - column index

value - the expression to use in the specified table cell

Throws:

java.rmi.RemoteException - remote communication problem

addColumn

void addColumn(int index)
        throws java.rmi.RemoteException

Adds a new column at index. Index values starts to count with zero.

Parameters:

index - column index

Throws:

java.rmi.RemoteException - remote communication problem

removeColumn

void removeColumn(int index)
           throws java.rmi.RemoteException

Removes the column at index. Index values starts to count with zero.

Parameters:

index - column index

Throws:

java.rmi.RemoteException - remote communication problem

addRow

void addRow(int index)
     throws java.rmi.RemoteException

Adds a new row at index. Index values starts to count with zero.

Parameters:

index - row index

Throws:

java.rmi.RemoteException - remote communication problem

removeRow

void removeRow(int index)
        throws java.rmi.RemoteException

Removes the row at index. Index values starts to count with zero.

Parameters:

index - row index

Throws:

java.rmi.RemoteException - remote communication problem

getColumnCount

int getColumnCount()
            throws java.rmi.RemoteException

Returns:

The number of columns, time column not included.

Throws:

java.rmi.RemoteException - remote communication problem

getRowCount

int getRowCount()
         throws java.rmi.RemoteException

Returns:

The number of rows, header row not included.

Throws:

java.rmi.RemoteException - remote communication problem