Class: AWSCDK::IoTFleetWise::CfnSignalCatalog::ActuatorProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_fleet_wise/cfn_signal_catalog.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_type:, fully_qualified_name:, allowed_values: nil, assigned_value: nil, description: nil, max: nil, min: nil, unit: nil) ⇒ ActuatorProperty

Returns a new instance of ActuatorProperty.

Parameters:

  • data_type (String) —

    The specified data type of the actuator.

  • fully_qualified_name (String) —

    The fully qualified name of the actuator.

  • allowed_values (Array<String>, nil) (defaults to: nil) —

    A list of possible values an actuator can take.

  • assigned_value (String, nil) (defaults to: nil) —

    A specified value for the actuator.

  • description (String, nil) (defaults to: nil) —

    A brief description of the actuator.

  • max (Numeric, nil) (defaults to: nil) —

    The specified possible maximum value of an actuator.

  • min (Numeric, nil) (defaults to: nil) —

    The specified possible minimum value of an actuator.

  • unit (String, nil) (defaults to: nil) —

    The scientific unit for the actuator.



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 639

def initialize(data_type:, fully_qualified_name:, allowed_values: nil, assigned_value: nil, description: nil, max: nil, min: nil, unit: nil)
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType")
  @fully_qualified_name = fully_qualified_name
  Jsii::Type.check_type(@fully_qualified_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fullyQualifiedName")
  @allowed_values = allowed_values
  Jsii::Type.check_type(@allowed_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedValues") unless @allowed_values.nil?
  @assigned_value = assigned_value
  Jsii::Type.check_type(@assigned_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assignedValue") unless @assigned_value.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @max = max
  Jsii::Type.check_type(@max, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "max") unless @max.nil?
  @min = min
  Jsii::Type.check_type(@min, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "min") unless @min.nil?
  @unit = unit
  Jsii::Type.check_type(@unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless @unit.nil?
end

Instance Attribute Details

#allowed_values ⇒ Array<String>? (readonly)

A list of possible values an actuator can take.

Returns:

  • (Array<String>, nil)

See Also:



674
675
676
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 674

def allowed_values
  @allowed_values
end

#assigned_value ⇒ String? (readonly)

A specified value for the actuator.

Returns:

  • (String, nil)

See Also:



679
680
681
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 679

def assigned_value
  @assigned_value
end

#data_type ⇒ String (readonly)

The specified data type of the actuator.

Returns:

  • (String)

See Also:



662
663
664
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 662

def data_type
  @data_type
end

#description ⇒ String? (readonly)

A brief description of the actuator.

Returns:

  • (String, nil)

See Also:



684
685
686
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 684

def description
  @description
end

#fully_qualified_name ⇒ String (readonly)

The fully qualified name of the actuator.

For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .

Returns:

  • (String)

See Also:



669
670
671
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 669

def fully_qualified_name
  @fully_qualified_name
end

#max ⇒ Numeric? (readonly)

The specified possible maximum value of an actuator.

Returns:

  • (Numeric, nil)

See Also:



689
690
691
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 689

def max
  @max
end

#min ⇒ Numeric? (readonly)

The specified possible minimum value of an actuator.

Returns:

  • (Numeric, nil)

See Also:



694
695
696
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 694

def min
  @min
end

#unit ⇒ String? (readonly)

The scientific unit for the actuator.

Returns:

  • (String, nil)

See Also:



699
700
701
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 699

def unit
  @unit
end

Class Method Details

.jsii_properties ⇒ Object 



701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 701

def self.jsii_properties
  {
    :data_type => "dataType",
    :fully_qualified_name => "fullyQualifiedName",
    :allowed_values => "allowedValues",
    :assigned_value => "assignedValue",
    :description => "description",
    :max => "max",
    :min => "min",
    :unit => "unit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 714

def to_jsii
  result = {}
  result.merge!({
    "dataType" => @data_type,
    "fullyQualifiedName" => @fully_qualified_name,
    "allowedValues" => @allowed_values,
    "assignedValue" => @assigned_value,
    "description" => @description,
    "max" => @max,
    "min" => @min,
    "unit" => @unit,
  })
  result.compact
end