class LUSI::API::Course::Mark

Represents a module mark in the LUSI API

Attributes

overall_aggregation[RW]

@!attribute [rw] overall_aggregation

@return [Float, nil] the overall aggregation score for the module
overall_percentage[RW]

@!attribute [rw] overall_percentage

@return [Float, nil] the overall percentage mark for the module

Public Class Methods

new(xml = nil, lookup = nil, overall_percentage: nil, overall_aggregation: nil) click to toggle source

Initialises a new Mark instance @param xml [Nokogir::XML::Document, Nokogiri::XML::Node] the parsed XML root of the mark @param lookup [LUSI::API::Core::Lookup::LookupService, nil] the lookup service for object resolution @param overall_aggregation [Float, int] the default overall aggregation @param overall_percentage [Float, int] the default overall percentage @return [void]

# File lib/lusi_api/course.rb, line 690
def initialize(xml = nil, lookup = nil, overall_percentage: nil, overall_aggregation: nil)
  @overall_percentage = LUSI::API::Core::XML.xml_float_at(xml, 'xmlns:OverallPercentage', overall_percentage)
  @overall_aggregation = LUSI::API::Core::XML.xml_float_at(xml, 'xmlns:OverallAggregation',
                                                           overall_aggregation)
end

Public Instance Methods

to_s() click to toggle source

Returns a string representation of the Mark instance @return [String] the string representation of the Mark instance

# File lib/lusi_api/course.rb, line 698
def to_s
  "#{@overall_aggregation} (#{@overall_percentage}%)"
end