Class: XbimAim::DocumentCreate

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

Overview

Represents a new document. This is an simplification of the IfcDocumentInformation and IfcDocumentReference concepts. See standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ifcexternalreferenceresource/lexical/ifcdocumentinformation.htm

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/xbim_aim/models/document_create.rb', line 109

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

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

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

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

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

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

  if attributes.key?(:'intended_use')
    self.intended_use = attributes[:'intended_use']
  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?(:'external_identifier')
    self.external_identifier = attributes[:'external_identifier']
  end

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

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

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

Instance Attribute Details

#asset_model_id ⇒ Object

The identifier of the Model this entity belongs to



41
42
43
 
# File 'lib/xbim_aim/models/document_create.rb', line 41

def asset_model_id
  @asset_model_id
end

#description ⇒ Object

Optional Description of the document



53
54
55
 
# File 'lib/xbim_aim/models/document_create.rb', line 53

def description
  @description
end

#entity_id ⇒ Object

Gets or sets the entity identifier / Label.



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

def entity_id
  @entity_id
end

#external_identifier ⇒ Object

The immutable unique identifier key for this Entity



47
48
49
 
# File 'lib/xbim_aim/models/document_create.rb', line 47

def external_identifier
  @external_identifier
end

#external_object_type ⇒ Object

A system identifier of the type of entity



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

def external_object_type
  @external_object_type
end

#intended_use ⇒ Object

Intended Use for this document.



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

def intended_use
  @intended_use
end

#item_reference ⇒ Object

Identifier for the referenced item in the external source (classification, document or library) For documents hosted in Flex this should be the fileId



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

def item_reference
  @item_reference
end

#location ⇒ Object

Location, where the external source (classification, document or library). For externally hosted documents normally given as an URL location string. For documents hosted in Flex, use the value ‘Flex’, and provide the Flex ‘fileId’ in the Item Reference



23
24
25
 
# File 'lib/xbim_aim/models/document_create.rb', line 23

def location
  @location
end

#name ⇒ Object

The name of the entity



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

def name
  @name
end

#purpose ⇒ Object

Purpose for this document.



35
36
37
 
# File 'lib/xbim_aim/models/document_create.rb', line 35

def purpose
  @purpose
end

#revision ⇒ Object

Document revision designation



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

def revision
  @revision
end

#scope ⇒ Object

Scope for this document.



29
30
31
 
# File 'lib/xbim_aim/models/document_create.rb', line 29

def scope
  @scope
end

#url ⇒ Object

The Url of the document. Prefer Location over setting the URL



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/xbim_aim/models/document_create.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/xbim_aim/models/document_create.rb', line 59

def self.attribute_map
  {
    :'url' => :'Url',
    :'location' => :'Location',
    :'item_reference' => :'ItemReference',
    :'scope' => :'Scope',
    :'revision' => :'Revision',
    :'purpose' => :'Purpose',
    :'intended_use' => :'IntendedUse',
    :'asset_model_id' => :'AssetModelId',
    :'entity_id' => :'EntityId',
    :'external_identifier' => :'ExternalIdentifier',
    :'name' => :'Name',
    :'description' => :'Description',
    :'external_object_type' => :'ExternalObjectType'
  }
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



228
229
230
 
# File 'lib/xbim_aim/models/document_create.rb', line 228

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
 
# File 'lib/xbim_aim/models/document_create.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/xbim_aim/models/document_create.rb', line 83

def self.openapi_types
  {
    :'url' => :'String',
    :'location' => :'String',
    :'item_reference' => :'String',
    :'scope' => :'String',
    :'revision' => :'String',
    :'purpose' => :'String',
    :'intended_use' => :'String',
    :'asset_model_id' => :'Integer',
    :'entity_id' => :'Integer',
    :'external_identifier' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'external_object_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/xbim_aim/models/document_create.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      location == o.location &&
      item_reference == o.item_reference &&
      scope == o.scope &&
      revision == o.revision &&
      purpose == o.purpose &&
      intended_use == o.intended_use &&
      asset_model_id == o.asset_model_id &&
      entity_id == o.entity_id &&
      external_identifier == o.external_identifier &&
      name == o.name &&
      description == o.description &&
      external_object_type == o.external_object_type
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



258
259
260
261
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
288
289
290
291
292
293
294
295
 
# File 'lib/xbim_aim/models/document_create.rb', line 258

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/xbim_aim/models/document_create.rb', line 329

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/xbim_aim/models/document_create.rb', line 235

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


215
216
217
 
# File 'lib/xbim_aim/models/document_create.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/xbim_aim/models/document_create.rb', line 221

def hash
  [url, location, item_reference, scope, revision, purpose, intended_use, asset_model_id, entity_id, external_identifier, name, description, external_object_type].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



177
178
179
180
181
182
183
184
 
# File 'lib/xbim_aim/models/document_create.rb', line 177

def list_invalid_properties
  invalid_properties = Array.new
  if @asset_model_id.nil?
    invalid_properties.push('invalid value for "asset_model_id", asset_model_id cannot be nil.')
  end

  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



305
306
307
 
# File 'lib/xbim_aim/models/document_create.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/xbim_aim/models/document_create.rb', line 311

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



299
300
301
 
# File 'lib/xbim_aim/models/document_create.rb', line 299

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



188
189
190
191
 
# File 'lib/xbim_aim/models/document_create.rb', line 188

def valid?
  return false if @asset_model_id.nil?
  true
end