Class: XbimComms::ScheduleColumn

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_comms/models/schedule_column.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduleColumn

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 117

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XbimComms::ScheduleColumn` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XbimComms::ScheduleColumn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'column_name')
    self.column_name = attributes[:'column_name']
  end

  if attributes.key?(:'heading_orientation')
    self.heading_orientation = attributes[:'heading_orientation']
  end

  if attributes.key?(:'horizontal_alignment')
    self.horizontal_alignment = attributes[:'horizontal_alignment']
  end

  if attributes.key?(:'accuracy')
    self.accuracy = attributes[:'accuracy']
  end

  if attributes.key?(:'can_have_unit_symbol')
    self.can_have_unit_symbol = attributes[:'can_have_unit_symbol']
  end

  if attributes.key?(:'rounding_method')
    self.rounding_method = attributes[:'rounding_method']
  end

  if attributes.key?(:'suppress_leading_zeros')
    self.suppress_leading_zeros = attributes[:'suppress_leading_zeros']
  end

  if attributes.key?(:'suppress_spaces')
    self.suppress_spaces = attributes[:'suppress_spaces']
  end

  if attributes.key?(:'suppress_trailing_zeros')
    self.suppress_trailing_zeros = attributes[:'suppress_trailing_zeros']
  end

  if attributes.key?(:'unit_symbol')
    self.unit_symbol = attributes[:'unit_symbol']
  end

  if attributes.key?(:'use_plus_prefix')
    self.use_plus_prefix = attributes[:'use_plus_prefix']
  end

  if attributes.key?(:'use_digit_grouping')
    self.use_digit_grouping = attributes[:'use_digit_grouping']
  end

  if attributes.key?(:'display_units')
    self.display_units = attributes[:'display_units']
  end
end

Instance Attribute Details

#accuracy ⇒ Object

Returns the value of attribute accuracy.



24
25
26
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 24

def accuracy
  @accuracy
end

#can_have_unit_symbol ⇒ Object

Returns the value of attribute can_have_unit_symbol.



26
27
28
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 26

def can_have_unit_symbol
  @can_have_unit_symbol
end

#column_name ⇒ Object

Returns the value of attribute column_name.



18
19
20
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 18

def column_name
  @column_name
end

#display_units ⇒ Object

Returns the value of attribute display_units.



42
43
44
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 42

def display_units
  @display_units
end

#heading_orientation ⇒ Object

Returns the value of attribute heading_orientation.



20
21
22
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 20

def heading_orientation
  @heading_orientation
end

#horizontal_alignment ⇒ Object

Returns the value of attribute horizontal_alignment.



22
23
24
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 22

def horizontal_alignment
  @horizontal_alignment
end

#rounding_method ⇒ Object

Returns the value of attribute rounding_method.



28
29
30
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 28

def rounding_method
  @rounding_method
end

#suppress_leading_zeros ⇒ Object

Returns the value of attribute suppress_leading_zeros.



30
31
32
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 30

def suppress_leading_zeros
  @suppress_leading_zeros
end

#suppress_spaces ⇒ Object

Returns the value of attribute suppress_spaces.



32
33
34
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 32

def suppress_spaces
  @suppress_spaces
end

#suppress_trailing_zeros ⇒ Object

Returns the value of attribute suppress_trailing_zeros.



34
35
36
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 34

def suppress_trailing_zeros
  @suppress_trailing_zeros
end

#unit_symbol ⇒ Object

Returns the value of attribute unit_symbol.



36
37
38
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 36

def unit_symbol
  @unit_symbol
end

#use_digit_grouping ⇒ Object

Returns the value of attribute use_digit_grouping.



40
41
42
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 40

def use_digit_grouping
  @use_digit_grouping
end

#use_plus_prefix ⇒ Object

Returns the value of attribute use_plus_prefix.



38
39
40
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 38

def use_plus_prefix
  @use_plus_prefix
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 67

def self.attribute_map
  {
    :'column_name' => :'columnName',
    :'heading_orientation' => :'headingOrientation',
    :'horizontal_alignment' => :'horizontalAlignment',
    :'accuracy' => :'accuracy',
    :'can_have_unit_symbol' => :'canHaveUnitSymbol',
    :'rounding_method' => :'roundingMethod',
    :'suppress_leading_zeros' => :'suppressLeadingZeros',
    :'suppress_spaces' => :'suppressSpaces',
    :'suppress_trailing_zeros' => :'suppressTrailingZeros',
    :'unit_symbol' => :'unitSymbol',
    :'use_plus_prefix' => :'usePlusPrefix',
    :'use_digit_grouping' => :'useDigitGrouping',
    :'display_units' => :'displayUnits'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 267

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 110

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'column_name' => :'String',
    :'heading_orientation' => :'String',
    :'horizontal_alignment' => :'String',
    :'accuracy' => :'Float',
    :'can_have_unit_symbol' => :'Boolean',
    :'rounding_method' => :'String',
    :'suppress_leading_zeros' => :'Boolean',
    :'suppress_spaces' => :'Boolean',
    :'suppress_trailing_zeros' => :'Boolean',
    :'unit_symbol' => :'String',
    :'use_plus_prefix' => :'Boolean',
    :'use_digit_grouping' => :'Boolean',
    :'display_units' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      column_name == o.column_name &&
      heading_orientation == o.heading_orientation &&
      horizontal_alignment == o.horizontal_alignment &&
      accuracy == o.accuracy &&
      can_have_unit_symbol == o.can_have_unit_symbol &&
      rounding_method == o.rounding_method &&
      suppress_leading_zeros == o.suppress_leading_zeros &&
      suppress_spaces == o.suppress_spaces &&
      suppress_trailing_zeros == o.suppress_trailing_zeros &&
      unit_symbol == o.unit_symbol &&
      use_plus_prefix == o.use_plus_prefix &&
      use_digit_grouping == o.use_digit_grouping &&
      display_units == o.display_units
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 297

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = XbimComms.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 368

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 260

def hash
  [column_name, heading_orientation, horizontal_alignment, accuracy, can_have_unit_symbol, rounding_method, suppress_leading_zeros, suppress_spaces, suppress_trailing_zeros, unit_symbol, use_plus_prefix, use_digit_grouping, display_units].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



185
186
187
188
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 185

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 344

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 350

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



338
339
340
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 338

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



192
193
194
195
196
197
198
199
200
 
# File 'lib/xbim_comms/models/schedule_column.rb', line 192

def valid?
  heading_orientation_validator = EnumAttributeValidator.new('String', ["Vertical", "Horizontal"])
  return false unless heading_orientation_validator.valid?(@heading_orientation)
  horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Left", "Right", "Center"])
  return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
  rounding_method_validator = EnumAttributeValidator.new('String', ["Nearest", "Up", "Down"])
  return false unless rounding_method_validator.valid?(@rounding_method)
  true
end