Class: XbimAim::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_aim/models/document.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/xbim_aim/models/document.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XbimAim::Document` 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 `XbimAim::Document`. 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?(:'documented_entities')
    if (value = attributes[:'documented_entities']).is_a?(Array)
      self.documented_entities = value
    end
  end

  if attributes.key?(:'documents')
    if (value = attributes[:'documents']).is_a?(Array)
      self.documents = value
    end
  end

  if attributes.key?(:'issues')
    if (value = attributes[:'issues']).is_a?(Array)
      self.issues = value
    end
  end

  if attributes.key?(:'contacts')
    if (value = attributes[:'contacts']).is_a?(Array)
      self.contacts = value
    end
  end

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

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

  if attributes.key?(:'attributes')
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end

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

  if attributes.key?(:'mapped_from')
    if (value = attributes[:'mapped_from']).is_a?(Array)
      self.mapped_from = value
    end
  end

  if attributes.key?(:'mapped_to')
    if (value = attributes[:'mapped_to']).is_a?(Array)
      self.mapped_to = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_model_id ⇒ Object

Returns the value of attribute asset_model_id.



40
41
42
 
# File 'lib/xbim_aim/models/document.rb', line 40

def asset_model_id
  @asset_model_id
end

#attributes ⇒ Object

Returns the value of attribute attributes.



30
31
32
 
# File 'lib/xbim_aim/models/document.rb', line 30

def attributes
  @attributes
end

#contacts ⇒ Object

Returns the value of attribute contacts.



24
25
26
 
# File 'lib/xbim_aim/models/document.rb', line 24

def contacts
  @contacts
end

#created_by ⇒ Object

Returns the value of attribute created_by.



26
27
28
 
# File 'lib/xbim_aim/models/document.rb', line 26

def created_by
  @created_by
end

#date_created ⇒ Object

Returns the value of attribute date_created.



58
59
60
 
# File 'lib/xbim_aim/models/document.rb', line 58

def date_created
  @date_created
end

#date_modified ⇒ Object

Returns the value of attribute date_modified.



60
61
62
 
# File 'lib/xbim_aim/models/document.rb', line 60

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



46
47
48
 
# File 'lib/xbim_aim/models/document.rb', line 46

def description
  @description
end

#documented_entities ⇒ Object

Returns the value of attribute documented_entities.



18
19
20
 
# File 'lib/xbim_aim/models/document.rb', line 18

def documented_entities
  @documented_entities
end

#documents ⇒ Object

Returns the value of attribute documents.



20
21
22
 
# File 'lib/xbim_aim/models/document.rb', line 20

def documents
  @documents
end

#entity_id ⇒ Object

Returns the value of attribute entity_id.



42
43
44
 
# File 'lib/xbim_aim/models/document.rb', line 42

def entity_id
  @entity_id
end

#external_identifier ⇒ Object

Returns the value of attribute external_identifier.



48
49
50
 
# File 'lib/xbim_aim/models/document.rb', line 48

def external_identifier
  @external_identifier
end

#external_object_name ⇒ Object

Returns the value of attribute external_object_name.



52
53
54
 
# File 'lib/xbim_aim/models/document.rb', line 52

def external_object_name
  @external_object_name
end

#external_object_type ⇒ Object

Returns the value of attribute external_object_type.



50
51
52
 
# File 'lib/xbim_aim/models/document.rb', line 50

def external_object_type
  @external_object_type
end

#footprint ⇒ Object

Returns the value of attribute footprint.



32
33
34
 
# File 'lib/xbim_aim/models/document.rb', line 32

def footprint
  @footprint
end

#ifc_type ⇒ Object

Returns the value of attribute ifc_type.



38
39
40
 
# File 'lib/xbim_aim/models/document.rb', line 38

def ifc_type
  @ifc_type
end

#issues ⇒ Object

Returns the value of attribute issues.



22
23
24
 
# File 'lib/xbim_aim/models/document.rb', line 22

def issues
  @issues
end

#mapped_from ⇒ Object

Returns the value of attribute mapped_from.



34
35
36
 
# File 'lib/xbim_aim/models/document.rb', line 34

def mapped_from
  @mapped_from
end

#mapped_to ⇒ Object

Returns the value of attribute mapped_to.



36
37
38
 
# File 'lib/xbim_aim/models/document.rb', line 36

def mapped_to
  @mapped_to
end

#model ⇒ Object

Returns the value of attribute model.



54
55
56
 
# File 'lib/xbim_aim/models/document.rb', line 54

def model
  @model
end

#model_name ⇒ Object

Returns the value of attribute model_name.



56
57
58
 
# File 'lib/xbim_aim/models/document.rb', line 56

def model_name
  @model_name
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



28
29
30
 
# File 'lib/xbim_aim/models/document.rb', line 28

def modified_by
  @modified_by
end

#name ⇒ Object

Returns the value of attribute name.



44
45
46
 
# File 'lib/xbim_aim/models/document.rb', line 44

def name
  @name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/xbim_aim/models/document.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/xbim_aim/models/document.rb', line 63

def self.attribute_map
  {
    :'documented_entities' => :'DocumentedEntities',
    :'documents' => :'Documents',
    :'issues' => :'Issues',
    :'contacts' => :'Contacts',
    :'created_by' => :'CreatedBy',
    :'modified_by' => :'ModifiedBy',
    :'attributes' => :'Attributes',
    :'footprint' => :'Footprint',
    :'mapped_from' => :'MappedFrom',
    :'mapped_to' => :'MappedTo',
    :'ifc_type' => :'IfcType',
    :'asset_model_id' => :'AssetModelId',
    :'entity_id' => :'EntityId',
    :'name' => :'Name',
    :'description' => :'Description',
    :'external_identifier' => :'ExternalIdentifier',
    :'external_object_type' => :'ExternalObjectType',
    :'external_object_name' => :'ExternalObjectName',
    :'model' => :'Model',
    :'model_name' => :'ModelName',
    :'date_created' => :'DateCreated',
    :'date_modified' => :'DateModified'
  }
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



304
305
306
 
# File 'lib/xbim_aim/models/document.rb', line 304

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



124
125
126
127
 
# File 'lib/xbim_aim/models/document.rb', line 124

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/xbim_aim/models/document.rb', line 96

def self.openapi_types
  {
    :'documented_entities' => :'Array<Object>',
    :'documents' => :'Array<DocumentInfo>',
    :'issues' => :'Array<IssueInfo>',
    :'contacts' => :'Array<EntityContact>',
    :'created_by' => :'EntityContact',
    :'modified_by' => :'EntityContact',
    :'attributes' => :'Array<AttributeValue>',
    :'footprint' => :'Footprint',
    :'mapped_from' => :'Array<EntityMappingInfo>',
    :'mapped_to' => :'Array<EntityMappingInfo>',
    :'ifc_type' => :'IfcType',
    :'asset_model_id' => :'Integer',
    :'entity_id' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'external_identifier' => :'String',
    :'external_object_type' => :'String',
    :'external_object_name' => :'String',
    :'model' => :'ModelInfo',
    :'model_name' => :'String',
    :'date_created' => :'Time',
    :'date_modified' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/xbim_aim/models/document.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      documented_entities == o.documented_entities &&
      documents == o.documents &&
      issues == o.issues &&
      contacts == o.contacts &&
      created_by == o.created_by &&
      modified_by == o.modified_by &&
      attributes == o.attributes &&
      footprint == o.footprint &&
      mapped_from == o.mapped_from &&
      mapped_to == o.mapped_to &&
      ifc_type == o.ifc_type &&
      asset_model_id == o.asset_model_id &&
      entity_id == o.entity_id &&
      name == o.name &&
      description == o.description &&
      external_identifier == o.external_identifier &&
      external_object_type == o.external_object_type &&
      external_object_name == o.external_object_name &&
      model == o.model &&
      model_name == o.model_name &&
      date_created == o.date_created &&
      date_modified == o.date_modified
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/xbim_aim/models/document.rb', line 334

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 = XbimAim.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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/xbim_aim/models/document.rb', line 405

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/xbim_aim/models/document.rb', line 311

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


291
292
293
 
# File 'lib/xbim_aim/models/document.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/xbim_aim/models/document.rb', line 297

def hash
  [documented_entities, documents, issues, contacts, created_by, modified_by, attributes, footprint, mapped_from, mapped_to, ifc_type, asset_model_id, entity_id, name, description, external_identifier, external_object_type, external_object_name, model, model_name, date_created, date_modified].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



249
250
251
252
 
# File 'lib/xbim_aim/models/document.rb', line 249

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



381
382
383
 
# File 'lib/xbim_aim/models/document.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/xbim_aim/models/document.rb', line 387

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



375
376
377
 
# File 'lib/xbim_aim/models/document.rb', line 375

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



256
257
258
 
# File 'lib/xbim_aim/models/document.rb', line 256

def valid?
  true
end