Sha256: 42e22db357637def9dffc568c10e6e05a3eb962d37f860194eb7c1691da1810d

Contents?: true

Size: 1.48 KB

Versions: 22

Compression:

Stored size: 1.48 KB

Contents

# Copyright (c) 2006-2009 National ICT Australia (NICTA), Australia
# This software may be used and distributed solely under the terms of the MIT license (License).
# You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
# By downloading or using this software you accept the terms and the liability disclaimer in the License.
#
# Copyright (c) 2004-2009 WINLAB, Rutgers University, USA

module OmfEc
  # This class describes a Parameter
  class Parameter

    attr_reader :id, :name, :description, :defaultValue

    #
    # Create a new Parameter instance
    #
    # - id = parameter identifier
    # - name = name for this parameter
    # - description = short description of this parameter
    # - defaultValue = optional, a defautl value for this parameter (default=nil)
    #
    def initialize(id, name, description, defaultValue = nil)
      @id = id
      @name = name != nil ? name : id
      @description = description
      @defaultValue = defaultValue
    end

    #
    # Return the definition of this Parameter as an XML element
    #
    # [Return] an XML element with the definition of this Parameter
    #
    def to_xml
      a = REXML::Element.new("parameter")
      a.add_attribute("id", id)
      a.add_attribute("name", name)
      if (description != nil)
        a.add_element("description").text = description
      end
      if (defaultValue != nil)
        a.add_element("default").text = defaultValue
      end
      return a
    end

  end
end

Version data entries

22 entries across 22 versions & 1 rubygems

Version Path
omf_ec-6.2.3 lib/omf_ec/parameter.rb
omf_ec-6.2.2 lib/omf_ec/parameter.rb
omf_ec-6.2.1 lib/omf_ec/parameter.rb
omf_ec-6.2.0 lib/omf_ec/parameter.rb
omf_ec-6.2.0.pre.2 lib/omf_ec/parameter.rb
omf_ec-6.2.0.pre.1 lib/omf_ec/parameter.rb
omf_ec-6.1.14.pre.2 lib/omf_ec/parameter.rb
omf_ec-6.1.14.pre.1 lib/omf_ec/parameter.rb
omf_ec-6.1.12 lib/omf_ec/parameter.rb
omf_ec-6.1.11 lib/omf_ec/parameter.rb
omf_ec-6.1.10 lib/omf_ec/parameter.rb
omf_ec-6.1.9 lib/omf_ec/parameter.rb
omf_ec-6.1.9.pre.4 lib/omf_ec/parameter.rb
omf_ec-6.1.9.pre.3 lib/omf_ec/parameter.rb
omf_ec-6.1.9.pre.2 lib/omf_ec/parameter.rb
omf_ec-6.1.8 lib/omf_ec/parameter.rb
omf_ec-6.1.7 lib/omf_ec/parameter.rb
omf_ec-6.1.6 lib/omf_ec/parameter.rb
omf_ec-6.1.6.pre.2 lib/omf_ec/parameter.rb
omf_ec-6.1.6.pre.1 lib/omf_ec/parameter.rb