Channel

All Superinterfaces:

Declaration, IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote
```
public interface Channel
extends Declaration
```
A channel carries the signal of a test stimulation.

Author:

Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Channel.ChannelMode
A channel can be an input, output, local or undefined.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Channel.ChannelMode`	`getMode()`	Get if the channel is an input, output, local or undefined.
`boolean`	`isRecord()`	Get if the channel shall be recorded during test execution.
`void`	`setMode(Channel.ChannelMode mode)`	Set the mode of the channel to input, output, local or undefined.
`void`	`setRecord(boolean on)`	Set if the channel should be recorded during test execution.

Methods inherited from interface com.piketec.tpt.api.Declaration
getDefaultValue, getDescription, getGroup, getType, getUnit, getUnitObject, setDefaultValue, setDescription, setGroup, setType, setUnit, setUnit

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

Methods inherited from interface com.piketec.tpt.api.NamedObject
getName, setName

- Method Detail
  - isRecord
```
boolean isRecord()
          throws java.rmi.RemoteException
```
    Get if the channel shall be recorded during test execution.
    
    Returns:
    
    true if the channel should be recorded, false otherwise.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - setRecord
```
void setRecord(boolean on)
        throws java.rmi.RemoteException
```
    Set if the channel should be recorded during test execution.
    
    Parameters:
    
    on - true if the channel should be recorded, false otherwise.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - getMode
```
Channel.ChannelMode getMode()
                     throws java.rmi.RemoteException
```
    Get if the channel is an input, output, local or undefined.
    
    Returns:
    
    The mode of the channel.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem
  - setMode
```
void setMode(Channel.ChannelMode mode)
      throws java.rmi.RemoteException
```
    Set the mode of the channel to input, output, local or undefined.
    
    Parameters:
    
    mode - The new mode of the channel.
    
    Throws:
    
    java.rmi.RemoteException - remote communication problem