Class: ShellEv::SingleLocationMarker

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_ev/models/single_location_marker.rb

Overview

A Marker is a place on the map that represent a single Location

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(marker_type = nil, unique_key = SKIP, status = SKIP, coordinates = SKIP, evse_count = SKIP, max_power = SKIP, geo_hash = SKIP, location_uid = SKIP, authorization_methods = SKIP, operator_id = SKIP) ⇒ SingleLocationMarker

Returns a new instance of SingleLocationMarker.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 91

def initialize(marker_type = nil, unique_key = SKIP, status = SKIP,
               coordinates = SKIP, evse_count = SKIP, max_power = SKIP,
               geo_hash = SKIP, location_uid = SKIP,
               authorization_methods = SKIP, operator_id = SKIP)
  @marker_type = marker_type
  @unique_key = unique_key unless unique_key == SKIP
  @status = status unless status == SKIP
  @coordinates = coordinates unless coordinates == SKIP
  @evse_count = evse_count unless evse_count == SKIP
  @max_power = max_power unless max_power == SKIP
  @geo_hash = geo_hash unless geo_hash == SKIP
  @location_uid = location_uid unless location_uid == SKIP
  @authorization_methods = authorization_methods unless authorization_methods == SKIP
  @operator_id = operator_id unless operator_id == SKIP
end

Instance Attribute Details

#authorization_methods ⇒ Array[SingleLocationMarkerAuthorizationMethodsItemsEnum]

Methods that can be used to Authorize sessions on this EVSE

Returns:



49
50
51
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 49

def authorization_methods
  @authorization_methods
end

#coordinates ⇒ Coordinates

Coordinates of the Shell Recharge Site Location

Returns:



28
29
30
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 28

def coordinates
  @coordinates
end

#evse_count ⇒ Float

Total number of Evse units in Locations that this Marker represents

Returns:

  • (Float) 


32
33
34
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 32

def evse_count
  @evse_count
end

#geo_hash ⇒ String

GeoHash of marker coordinates

Returns:

  • (String) 


41
42
43
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 41

def geo_hash
  @geo_hash
end

#location_uid ⇒ Float

Unique ID of the Location this Marker represents

Returns:

  • (Float) 


45
46
47
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 45

def location_uid
  @location_uid
end

#marker_type ⇒ String

Identifies the marker type. If it’s a ‘SingleLocationMarker`, then the value is `SingleLocation`

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 15

def marker_type
  @marker_type
end

#max_power ⇒ Float

Maximum power in kW across all locations grouped in this marker (disregarding availability)

Returns:

  • (Float) 


37
38
39
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 37

def max_power
  @max_power
end

#operator_id ⇒ String

Unique Id of the operator

Returns:

  • (String) 


53
54
55
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 53

def operator_id
  @operator_id
end

#status ⇒ SingleLocationMarkerStatusEnum

Minimum of all status values in the Marker, e.g. if at least one Evse in the Marker is available, the value will be available

Returns:



24
25
26
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 24

def status
  @status
end

#unique_key ⇒ String

Uniquely identifies the marker object

Returns:

  • (String) 


19
20
21
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 19

def unique_key
  @unique_key
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 108

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  marker_type = hash.key?('markerType') ? hash['markerType'] : nil
  unique_key = hash.key?('uniqueKey') ? hash['uniqueKey'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  coordinates = Coordinates.from_hash(hash['coordinates']) if hash['coordinates']
  evse_count = hash.key?('evseCount') ? hash['evseCount'] : SKIP
  max_power = hash.key?('maxPower') ? hash['maxPower'] : SKIP
  geo_hash = hash.key?('geoHash') ? hash['geoHash'] : SKIP
  location_uid = hash.key?('locationUid') ? hash['locationUid'] : SKIP
  authorization_methods =
    hash.key?('authorizationMethods') ? hash['authorizationMethods'] : SKIP
  operator_id = hash.key?('operatorId') ? hash['operatorId'] : SKIP

  # Create object from extracted values.
  SingleLocationMarker.new(marker_type,
                           unique_key,
                           status,
                           coordinates,
                           evse_count,
                           max_power,
                           geo_hash,
                           location_uid,
                           authorization_methods,
                           operator_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 56

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['marker_type'] = 'markerType'
  @_hash['unique_key'] = 'uniqueKey'
  @_hash['status'] = 'status'
  @_hash['coordinates'] = 'coordinates'
  @_hash['evse_count'] = 'evseCount'
  @_hash['max_power'] = 'maxPower'
  @_hash['geo_hash'] = 'geoHash'
  @_hash['location_uid'] = 'locationUid'
  @_hash['authorization_methods'] = 'authorizationMethods'
  @_hash['operator_id'] = 'operatorId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



87
88
89
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 87

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 72

def self.optionals
  %w[
    unique_key
    status
    coordinates
    evse_count
    max_power
    geo_hash
    location_uid
    authorization_methods
    operator_id
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/shell_ev/models/single_location_marker.rb', line 139

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.marker_type,
                                 ->(val) { val.instance_of? String })
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['markerType'],
                        ->(val) { val.instance_of? String })
end