Class: Io::Flow::V0::Models::UnitOfMeasurement

Inherits:

Object

• Object
• Io::Flow::V0::Models::UnitOfMeasurement

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #value ⇒ Object readonly

  Returns the value of attribute value.

Class Method Summary

• .ALL ⇒ Object
• .apply(value) ⇒ Object

  Returns the instance of UnitOfMeasurement for this value, creating a new instance for an unknown value.

• .centimeter ⇒ Object

  Equivalent to CENTI(METRE).

• .cubic_inch ⇒ Object

  A unit of volume equal to one cubic inch (in³).

• .cubic_meter ⇒ Object

  The metric unit for volume quantities (m³).

• .foot ⇒ Object

  A unit of length equal to 0.3048 m (standard name ft).

• .from_string(value) ⇒ Object

  Returns the instance of UnitOfMeasurement for this value, or nil if not found.

• .gram ⇒ Object

  A unit of mass equal to 1 / 1000 kilogram (standard name g).

• .inch ⇒ Object

  A unit of length equal to 0.01004 m (standard name in).

• .kilogram ⇒ Object

  The base unit for mass quantities (kg).

• .meter ⇒ Object

  The base unit for length quantities (m).

• .millimeter ⇒ Object

  Equivalent to MILLI(METRE).

• .ounce ⇒ Object

  A unit of mass equal to 1 / 16 POUND (standard name oz).

• .pound ⇒ Object

  A unit of mass equal to 453.59237 grams (avoirdupois pound, standard name lb).

Instance Method Summary

• #initialize(value) ⇒ UnitOfMeasurement constructor

  A new instance of UnitOfMeasurement.

• #to_hash ⇒ Object

Constructor Details

#initialize(value) ⇒ UnitOfMeasurement

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11135

def initialize(value)
  @value = HttpClient::Preconditions.assert_class('value', value, String)
end

Instance Attribute Details

#value ⇒ Object (readonly)

Returns the value of attribute value.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11133

def value
  @value
end

Class Method Details

.ALL ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11155

def UnitOfMeasurement.ALL
  @@all ||= [UnitOfMeasurement.millimeter, UnitOfMeasurement.centimeter, UnitOfMeasurement.inch, UnitOfMeasurement.foot, UnitOfMeasurement.cubic_inch, UnitOfMeasurement.cubic_meter, UnitOfMeasurement.gram, UnitOfMeasurement.kilogram, UnitOfMeasurement.meter, UnitOfMeasurement.ounce, UnitOfMeasurement.pound]
end

.apply(value) ⇒ Object

Returns the instance of UnitOfMeasurement for this value, creating a new instance for an unknown value

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11140

def UnitOfMeasurement.apply(value)
  if value.instance_of?(UnitOfMeasurement)
    value
  else
    HttpClient::Preconditions.assert_class_or_nil('value', value, String)
    value.nil? ? nil : (from_string(value) || UnitOfMeasurement.new(value))
  end
end

.centimeter ⇒ Object

Equivalent to CENTI(METRE).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11165

def UnitOfMeasurement.centimeter
  @@_centimeter ||= UnitOfMeasurement.new('centimeter')
end

.cubic_inch ⇒ Object

A unit of volume equal to one cubic inch (in³).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11180

def UnitOfMeasurement.cubic_inch
  @@_cubic_inch ||= UnitOfMeasurement.new('cubic_inch')
end

.cubic_meter ⇒ Object

The metric unit for volume quantities (m³).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11185

def UnitOfMeasurement.cubic_meter
  @@_cubic_meter ||= UnitOfMeasurement.new('cubic_meter')
end

.foot ⇒ Object

A unit of length equal to 0.3048 m (standard name ft).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11175

def UnitOfMeasurement.foot
  @@_foot ||= UnitOfMeasurement.new('foot')
end

.from_string(value) ⇒ Object

Returns the instance of UnitOfMeasurement for this value, or nil if not found

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11150

def UnitOfMeasurement.from_string(value)
  HttpClient::Preconditions.assert_class('value', value, String)
  UnitOfMeasurement.ALL.find { |v| v.value == value }
end

.gram ⇒ Object

A unit of mass equal to 1 / 1000 kilogram (standard name g).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11190

def UnitOfMeasurement.gram
  @@_gram ||= UnitOfMeasurement.new('gram')
end

.inch ⇒ Object

A unit of length equal to 0.01004 m (standard name in).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11170

def UnitOfMeasurement.inch
  @@_inch ||= UnitOfMeasurement.new('inch')
end

.kilogram ⇒ Object

The base unit for mass quantities (kg).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11195

def UnitOfMeasurement.kilogram
  @@_kilogram ||= UnitOfMeasurement.new('kilogram')
end

.meter ⇒ Object

The base unit for length quantities (m).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11200

def UnitOfMeasurement.meter
  @@_meter ||= UnitOfMeasurement.new('meter')
end

.millimeter ⇒ Object

Equivalent to MILLI(METRE).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11160

def UnitOfMeasurement.millimeter
  @@_millimeter ||= UnitOfMeasurement.new('millimeter')
end

.ounce ⇒ Object

A unit of mass equal to 1 / 16 POUND (standard name oz).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11205

def UnitOfMeasurement.ounce
  @@_ounce ||= UnitOfMeasurement.new('ounce')
end

.pound ⇒ Object

A unit of mass equal to 453.59237 grams (avoirdupois pound, standard name lb).

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11210

def UnitOfMeasurement.pound
  @@_pound ||= UnitOfMeasurement.new('pound')
end

Instance Method Details

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11214

def to_hash
  value
end