/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the iotfleetwise-2021-06-17.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.IoTFleetWise.Model
{
///
/// A signal that represents a vehicle device such as the engine, heater, and door locks.
/// Data from an actuator reports the state of a certain vehicle device.
///
///
///
/// Updating actuator data can change the state of a device. For example, you can turn
/// on or off the heater by updating its actuator data.
///
///
///
public partial class Actuator
{
private List _allowedValues = new List();
private string _assignedValue;
private string _comment;
private NodeDataType _dataType;
private string _deprecationMessage;
private string _description;
private string _fullyQualifiedName;
private double? _max;
private double? _min;
private string _unit;
///
/// Gets and sets the property AllowedValues.
///
/// A list of possible values an actuator can take.
///
///
public List AllowedValues
{
get { return this._allowedValues; }
set { this._allowedValues = value; }
}
// Check to see if AllowedValues property is set
internal bool IsSetAllowedValues()
{
return this._allowedValues != null && this._allowedValues.Count > 0;
}
///
/// Gets and sets the property AssignedValue.
///
/// A specified value for the actuator.
///
///
[Obsolete("assignedValue is no longer in use")]
public string AssignedValue
{
get { return this._assignedValue; }
set { this._assignedValue = value; }
}
// Check to see if AssignedValue property is set
internal bool IsSetAssignedValue()
{
return this._assignedValue != null;
}
///
/// Gets and sets the property Comment.
///
/// A comment in addition to the description.
///
///
[AWSProperty(Min=1, Max=2048)]
public string Comment
{
get { return this._comment; }
set { this._comment = value; }
}
// Check to see if Comment property is set
internal bool IsSetComment()
{
return this._comment != null;
}
///
/// Gets and sets the property DataType.
///
/// The specified data type of the actuator.
///
///
[AWSProperty(Required=true)]
public NodeDataType DataType
{
get { return this._dataType; }
set { this._dataType = value; }
}
// Check to see if DataType property is set
internal bool IsSetDataType()
{
return this._dataType != null;
}
///
/// Gets and sets the property DeprecationMessage.
///
/// The deprecation message for the node or the branch that was moved or deleted.
///
///
[AWSProperty(Min=1, Max=2048)]
public string DeprecationMessage
{
get { return this._deprecationMessage; }
set { this._deprecationMessage = value; }
}
// Check to see if DeprecationMessage property is set
internal bool IsSetDeprecationMessage()
{
return this._deprecationMessage != null;
}
///
/// Gets and sets the property Description.
///
/// A brief description of the actuator.
///
///
[AWSProperty(Min=1, Max=2048)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property FullyQualifiedName.
///
/// The fully qualified name of the actuator. For example, the fully qualified name of
/// an actuator might be Vehicle.Front.Left.Door.Lock
.
///
///
[AWSProperty(Required=true)]
public string FullyQualifiedName
{
get { return this._fullyQualifiedName; }
set { this._fullyQualifiedName = value; }
}
// Check to see if FullyQualifiedName property is set
internal bool IsSetFullyQualifiedName()
{
return this._fullyQualifiedName != null;
}
///
/// Gets and sets the property Max.
///
/// The specified possible maximum value of an actuator.
///
///
public double Max
{
get { return this._max.GetValueOrDefault(); }
set { this._max = value; }
}
// Check to see if Max property is set
internal bool IsSetMax()
{
return this._max.HasValue;
}
///
/// Gets and sets the property Min.
///
/// The specified possible minimum value of an actuator.
///
///
public double Min
{
get { return this._min.GetValueOrDefault(); }
set { this._min = value; }
}
// Check to see if Min property is set
internal bool IsSetMin()
{
return this._min.HasValue;
}
///
/// Gets and sets the property Unit.
///
/// The scientific unit for the actuator.
///
///
public string Unit
{
get { return this._unit; }
set { this._unit = value; }
}
// Check to see if Unit property is set
internal bool IsSetUnit()
{
return this._unit != null;
}
}
}