/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/iotfleetwise/IoTFleetWise_EXPORTS.h>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace IoTFleetWise
{
namespace Model
{

  /**
   * <p>Information about signal messages using the on-board diagnostics (OBD) II
   * protocol in a vehicle.</p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/ObdSignal">AWS
   * API Reference</a></p>
   */
  class ObdSignal
  {
  public:
    AWS_IOTFLEETWISE_API ObdSignal();
    AWS_IOTFLEETWISE_API ObdSignal(Aws::Utils::Json::JsonView jsonValue);
    AWS_IOTFLEETWISE_API ObdSignal& operator=(Aws::Utils::Json::JsonView jsonValue);
    AWS_IOTFLEETWISE_API Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The length of the requested data.</p>
     */
    inline int GetPidResponseLength() const{ return m_pidResponseLength; }

    /**
     * <p>The length of the requested data.</p>
     */
    inline bool PidResponseLengthHasBeenSet() const { return m_pidResponseLengthHasBeenSet; }

    /**
     * <p>The length of the requested data.</p>
     */
    inline void SetPidResponseLength(int value) { m_pidResponseLengthHasBeenSet = true; m_pidResponseLength = value; }

    /**
     * <p>The length of the requested data.</p>
     */
    inline ObdSignal& WithPidResponseLength(int value) { SetPidResponseLength(value); return *this;}


    /**
     * <p>The mode of operation (diagnostic service) in a message.</p>
     */
    inline int GetServiceMode() const{ return m_serviceMode; }

    /**
     * <p>The mode of operation (diagnostic service) in a message.</p>
     */
    inline bool ServiceModeHasBeenSet() const { return m_serviceModeHasBeenSet; }

    /**
     * <p>The mode of operation (diagnostic service) in a message.</p>
     */
    inline void SetServiceMode(int value) { m_serviceModeHasBeenSet = true; m_serviceMode = value; }

    /**
     * <p>The mode of operation (diagnostic service) in a message.</p>
     */
    inline ObdSignal& WithServiceMode(int value) { SetServiceMode(value); return *this;}


    /**
     * <p>The diagnostic code used to request data from a vehicle for this signal.</p>
     */
    inline int GetPid() const{ return m_pid; }

    /**
     * <p>The diagnostic code used to request data from a vehicle for this signal.</p>
     */
    inline bool PidHasBeenSet() const { return m_pidHasBeenSet; }

    /**
     * <p>The diagnostic code used to request data from a vehicle for this signal.</p>
     */
    inline void SetPid(int value) { m_pidHasBeenSet = true; m_pid = value; }

    /**
     * <p>The diagnostic code used to request data from a vehicle for this signal.</p>
     */
    inline ObdSignal& WithPid(int value) { SetPid(value); return *this;}


    /**
     * <p>A multiplier used to decode the message.</p>
     */
    inline double GetScaling() const{ return m_scaling; }

    /**
     * <p>A multiplier used to decode the message.</p>
     */
    inline bool ScalingHasBeenSet() const { return m_scalingHasBeenSet; }

    /**
     * <p>A multiplier used to decode the message.</p>
     */
    inline void SetScaling(double value) { m_scalingHasBeenSet = true; m_scaling = value; }

    /**
     * <p>A multiplier used to decode the message.</p>
     */
    inline ObdSignal& WithScaling(double value) { SetScaling(value); return *this;}


    /**
     * <p>The offset used to calculate the signal value. Combined with scaling, the
     * calculation is <code>value = raw_value * scaling + offset</code>.</p>
     */
    inline double GetOffset() const{ return m_offset; }

    /**
     * <p>The offset used to calculate the signal value. Combined with scaling, the
     * calculation is <code>value = raw_value * scaling + offset</code>.</p>
     */
    inline bool OffsetHasBeenSet() const { return m_offsetHasBeenSet; }

    /**
     * <p>The offset used to calculate the signal value. Combined with scaling, the
     * calculation is <code>value = raw_value * scaling + offset</code>.</p>
     */
    inline void SetOffset(double value) { m_offsetHasBeenSet = true; m_offset = value; }

    /**
     * <p>The offset used to calculate the signal value. Combined with scaling, the
     * calculation is <code>value = raw_value * scaling + offset</code>.</p>
     */
    inline ObdSignal& WithOffset(double value) { SetOffset(value); return *this;}


    /**
     * <p>Indicates the beginning of the message.</p>
     */
    inline int GetStartByte() const{ return m_startByte; }

    /**
     * <p>Indicates the beginning of the message.</p>
     */
    inline bool StartByteHasBeenSet() const { return m_startByteHasBeenSet; }

    /**
     * <p>Indicates the beginning of the message.</p>
     */
    inline void SetStartByte(int value) { m_startByteHasBeenSet = true; m_startByte = value; }

    /**
     * <p>Indicates the beginning of the message.</p>
     */
    inline ObdSignal& WithStartByte(int value) { SetStartByte(value); return *this;}


    /**
     * <p>The length of a message.</p>
     */
    inline int GetByteLength() const{ return m_byteLength; }

    /**
     * <p>The length of a message.</p>
     */
    inline bool ByteLengthHasBeenSet() const { return m_byteLengthHasBeenSet; }

    /**
     * <p>The length of a message.</p>
     */
    inline void SetByteLength(int value) { m_byteLengthHasBeenSet = true; m_byteLength = value; }

    /**
     * <p>The length of a message.</p>
     */
    inline ObdSignal& WithByteLength(int value) { SetByteLength(value); return *this;}


    /**
     * <p>The number of positions to shift bits in the message.</p>
     */
    inline int GetBitRightShift() const{ return m_bitRightShift; }

    /**
     * <p>The number of positions to shift bits in the message.</p>
     */
    inline bool BitRightShiftHasBeenSet() const { return m_bitRightShiftHasBeenSet; }

    /**
     * <p>The number of positions to shift bits in the message.</p>
     */
    inline void SetBitRightShift(int value) { m_bitRightShiftHasBeenSet = true; m_bitRightShift = value; }

    /**
     * <p>The number of positions to shift bits in the message.</p>
     */
    inline ObdSignal& WithBitRightShift(int value) { SetBitRightShift(value); return *this;}


    /**
     * <p>The number of bits to mask in a message.</p>
     */
    inline int GetBitMaskLength() const{ return m_bitMaskLength; }

    /**
     * <p>The number of bits to mask in a message.</p>
     */
    inline bool BitMaskLengthHasBeenSet() const { return m_bitMaskLengthHasBeenSet; }

    /**
     * <p>The number of bits to mask in a message.</p>
     */
    inline void SetBitMaskLength(int value) { m_bitMaskLengthHasBeenSet = true; m_bitMaskLength = value; }

    /**
     * <p>The number of bits to mask in a message.</p>
     */
    inline ObdSignal& WithBitMaskLength(int value) { SetBitMaskLength(value); return *this;}

  private:

    int m_pidResponseLength;
    bool m_pidResponseLengthHasBeenSet = false;

    int m_serviceMode;
    bool m_serviceModeHasBeenSet = false;

    int m_pid;
    bool m_pidHasBeenSet = false;

    double m_scaling;
    bool m_scalingHasBeenSet = false;

    double m_offset;
    bool m_offsetHasBeenSet = false;

    int m_startByte;
    bool m_startByteHasBeenSet = false;

    int m_byteLength;
    bool m_byteLengthHasBeenSet = false;

    int m_bitRightShift;
    bool m_bitRightShiftHasBeenSet = false;

    int m_bitMaskLength;
    bool m_bitMaskLengthHasBeenSet = false;
  };

} // namespace Model
} // namespace IoTFleetWise
} // namespace Aws