Class: Proj::Parameter

Inherits:
Object
  • Object
show all
Defined in:
lib/proj/parameter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, auth_name: nil, code: nil, value:, unit_conv_factor:, unit_name: nil, unit_type:) ⇒ Parameter

Returns a new instance of Parameter.



20
21
22
23
24
25
26
27
28
 
# File 'lib/proj/parameter.rb', line 20

def initialize(name:, auth_name: nil, code: nil, value:, unit_conv_factor:, unit_name: nil, unit_type:)
  @name = name
  @auth_name = auth_name
  @code = code
  @value = value
  @unit_conv_factor = unit_conv_factor
  @unit_name = unit_name
  @unit_type = unit_type
end

Instance Attribute Details

#auth_name ⇒ String (readonly)

Returns Authority name.

Returns:

  • (String) —

    Authority name



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

#code ⇒ String (readonly)

Returns Authority code.

Returns:

  • (String) —

    Authority code



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

#name ⇒ String (readonly)

Returns Param name.

Returns:

  • (String) —

    Param name



17
18
19
 
# File 'lib/proj/parameter.rb', line 17

def name
  @name
end

#unit_conv_factor ⇒ String (readonly)

Returns Param unit_conv_factor.

Returns:

  • (String) —

    Param unit_conv_factor



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

#unit_name ⇒ String (readonly)

Returns Param unit_name.

Returns:

  • (String) —

    Param unit_name



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

#unit_type ⇒ Object (readonly)

Returns the value of attribute unit_type.



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

#value ⇒ String (readonly)

Returns Param value.

Returns:

  • (String) —

    Param value



17
18
 
# File 'lib/proj/parameter.rb', line 17

attr_reader :name, :auth_name, :code, :value,
:unit_conv_factor, :unit_name, :unit_type

Instance Method Details

#to_description ⇒ PJ_PARAM_DESCRIPTION

Returns param information in PJ_PARAM_DESCRIPTION structure

Returns:

  • (PJ_PARAM_DESCRIPTION) 


33
34
35
36
 
# File 'lib/proj/parameter.rb', line 33

def to_description
  Api::PJ_PARAM_DESCRIPTION.create(name: name, auth_name: auth_name, code: code, value: value,
                                   unit_conv_factor: unit_conv_factor, unit_name: name, unit_type: unit_type)
end