lib/urbanopt/scenario/simulation_dir_osw.rb in urbanopt-scenario-0.4.2 vs lib/urbanopt/scenario/simulation_dir_osw.rb in urbanopt-scenario-0.4.3
- old
+ new
@@ -35,13 +35,13 @@
class SimulationDirOSW < SimulationDirBase
##
# SimulationDirOSW creates a OSW file to simulate features, a SimulationMapperBase is invoked to translate features to OSW.
##
# [parameters:]
- # +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
- # +features+ - _Array_ - Array of Features this SimulationFile represents.
- # +feature_names+ - _Array_ - Array of scenario specific names for these Features.
- # +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
+ # * +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
+ # * +features+ - _Array_ - Array of Features this SimulationFile represents.
+ # * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
+ # * +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
def initialize(scenario, features, feature_names, mapper_class)
super(scenario, features, feature_names)
if features.size != 1
raise 'SimulationDirOSW currently cannot simulate more than one feature'