CanSignal (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotfleetwise.model.CanSignal

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanSignal
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a single controller area network (CAN) signal and the messages it receives and transmits.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanSignal()

Constructors
Constructor and Description
`CanSignal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanSignal`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getFactor()` A multiplier used to decode the CAN message.
`Boolean`	`getIsBigEndian()` Whether the byte ordering of a CAN message is big-endian.
`Boolean`	`getIsSigned()` Whether the message data is specified as a signed value.
`Integer`	`getLength()` How many bytes of data are in the message.
`Integer`	`getMessageId()` The ID of the message.
`String`	`getName()` The name of the signal.
`Double`	`getOffset()` The offset used to calculate the signal value.
`Integer`	`getStartBit()` Indicates the beginning of the CAN signal.
`int`	`hashCode()`
`Boolean`	`isBigEndian()` Whether the byte ordering of a CAN message is big-endian.
`Boolean`	`isSigned()` Whether the message data is specified as a signed value.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFactor(Double factor)` A multiplier used to decode the CAN message.
`void`	`setIsBigEndian(Boolean isBigEndian)` Whether the byte ordering of a CAN message is big-endian.
`void`	`setIsSigned(Boolean isSigned)` Whether the message data is specified as a signed value.
`void`	`setLength(Integer length)` How many bytes of data are in the message.
`void`	`setMessageId(Integer messageId)` The ID of the message.
`void`	`setName(String name)` The name of the signal.
`void`	`setOffset(Double offset)` The offset used to calculate the signal value.
`void`	`setStartBit(Integer startBit)` Indicates the beginning of the CAN signal.
`String`	`toString()` Returns a string representation of this object.
`CanSignal`	`withFactor(Double factor)` A multiplier used to decode the CAN message.
`CanSignal`	`withIsBigEndian(Boolean isBigEndian)` Whether the byte ordering of a CAN message is big-endian.
`CanSignal`	`withIsSigned(Boolean isSigned)` Whether the message data is specified as a signed value.
`CanSignal`	`withLength(Integer length)` How many bytes of data are in the message.
`CanSignal`	`withMessageId(Integer messageId)` The ID of the message.
`CanSignal`	`withName(String name)` The name of the signal.
`CanSignal`	`withOffset(Double offset)` The offset used to calculate the signal value.
`CanSignal`	`withStartBit(Integer startBit)` Indicates the beginning of the CAN signal.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CanSignal
```
public CanSignal()
```
- Method Detail
  - setMessageId
```
public void setMessageId(Integer messageId)
```
    The ID of the message.
    
    Parameters:
    
    messageId - The ID of the message.
  - getMessageId
```
public Integer getMessageId()
```
    The ID of the message.
    
    Returns:
    
    The ID of the message.
  - withMessageId
```
public CanSignal withMessageId(Integer messageId)
```
    The ID of the message.
    
    Parameters:
    
    messageId - The ID of the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsBigEndian
```
public void setIsBigEndian(Boolean isBigEndian)
```
    Whether the byte ordering of a CAN message is big-endian.
    
    Parameters:
    
    isBigEndian - Whether the byte ordering of a CAN message is big-endian.
  - getIsBigEndian
```
public Boolean getIsBigEndian()
```
    Whether the byte ordering of a CAN message is big-endian.
    
    Returns:
    
    Whether the byte ordering of a CAN message is big-endian.
  - withIsBigEndian
```
public CanSignal withIsBigEndian(Boolean isBigEndian)
```
    Whether the byte ordering of a CAN message is big-endian.
    
    Parameters:
    
    isBigEndian - Whether the byte ordering of a CAN message is big-endian.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBigEndian
```
public Boolean isBigEndian()
```
    Whether the byte ordering of a CAN message is big-endian.
    
    Returns:
    
    Whether the byte ordering of a CAN message is big-endian.
  - setIsSigned
```
public void setIsSigned(Boolean isSigned)
```
    Whether the message data is specified as a signed value.
    
    Parameters:
    
    isSigned - Whether the message data is specified as a signed value.
  - getIsSigned
```
public Boolean getIsSigned()
```
    Whether the message data is specified as a signed value.
    
    Returns:
    
    Whether the message data is specified as a signed value.
  - withIsSigned
```
public CanSignal withIsSigned(Boolean isSigned)
```
    Whether the message data is specified as a signed value.
    
    Parameters:
    
    isSigned - Whether the message data is specified as a signed value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSigned
```
public Boolean isSigned()
```
    Whether the message data is specified as a signed value.
    
    Returns:
    
    Whether the message data is specified as a signed value.
  - setStartBit
```
public void setStartBit(Integer startBit)
```
    Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
    
    Parameters:
    
    startBit - Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
  - getStartBit
```
public Integer getStartBit()
```
    Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
    
    Returns:
    
    Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
  - withStartBit
```
public CanSignal withStartBit(Integer startBit)
```
    Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
    
    Parameters:
    
    startBit - Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
    
    This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOffset
```
public void setOffset(Double offset)
```
    The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
    
    Parameters:
    
    offset - The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
  - getOffset
```
public Double getOffset()
```
    The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
    
    Returns:
    
    The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
  - withOffset
```
public CanSignal withOffset(Double offset)
```
    The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
    
    Parameters:
    
    offset - The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFactor
```
public void setFactor(Double factor)
```
    A multiplier used to decode the CAN message.
    
    Parameters:
    
    factor - A multiplier used to decode the CAN message.
  - getFactor
```
public Double getFactor()
```
    A multiplier used to decode the CAN message.
    
    Returns:
    
    A multiplier used to decode the CAN message.
  - withFactor
```
public CanSignal withFactor(Double factor)
```
    A multiplier used to decode the CAN message.
    
    Parameters:
    
    factor - A multiplier used to decode the CAN message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLength
```
public void setLength(Integer length)
```
    How many bytes of data are in the message.
    
    Parameters:
    
    length - How many bytes of data are in the message.
  - getLength
```
public Integer getLength()
```
    How many bytes of data are in the message.
    
    Returns:
    
    How many bytes of data are in the message.
  - withLength
```
public CanSignal withLength(Integer length)
```
    How many bytes of data are in the message.
    
    Parameters:
    
    length - How many bytes of data are in the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the signal.
    
    Parameters:
    
    name - The name of the signal.
  - getName
```
public String getName()
```
    The name of the signal.
    
    Returns:
    
    The name of the signal.
  - withName
```
public CanSignal withName(String name)
```
    The name of the signal.
    
    Parameters:
    
    name - The name of the signal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CanSignal clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class CanSignal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanSignal

Method Detail

setMessageId

getMessageId

withMessageId

setIsBigEndian

getIsBigEndian

withIsBigEndian

isBigEndian

setIsSigned

getIsSigned

withIsSigned

isSigned

setStartBit

getStartBit

withStartBit

setOffset

getOffset

withOffset

setFactor

getFactor

withFactor

setLength

getLength

withLength

setName

getName

withName

toString

equals

hashCode

clone

marshall