honeybee_radiance_command.options.optionbase module¶

Base classes for Radiance Options.

class honeybee_radiance_command.options.optionbase.BoolOption(name, description, value=None)[source]¶

Bases: honeybee_radiance_command.options.optionbase.Option

Boolean Radiance option.

ToString()¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

property value¶: Option value.

class honeybee_radiance_command.options.optionbase.FileOption(name, description, value=None)[source]¶

Bases: honeybee_radiance_command.options.optionbase.Option

ToString()¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

property value¶: Option value.

class honeybee_radiance_command.options.optionbase.IntegerOption(name, description, value=None, min_value=- inf, max_value=inf)[source]¶

Bases: honeybee_radiance_command.options.optionbase.NumericOption

Integer Radiance option.

ToString()¶

to_radiance()¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

max_value¶

min_value¶

property name¶

property value¶: Option value.

class honeybee_radiance_command.options.optionbase.NumericOption(name, description, value=None, min_value=- inf, max_value=inf)[source]¶

Bases: honeybee_radiance_command.options.optionbase.Option

Numerical Radiance option.

ToString()¶

to_radiance()¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

max_value¶

min_value¶

property name¶

property value¶: Option value.

class honeybee_radiance_command.options.optionbase.Option(name, description, value=None)[source]¶

Bases: object

Radiance Option base class.

ToString()[source]¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

property value¶: Option value.

class honeybee_radiance_command.options.optionbase.OptionCollection[source]¶

Bases: object

Collection of Radiance Options.

This is base class for difference Radiance command options.

to_file(folder, file_name, mkdir=False)[source]¶: Write options to a file.

to_radiance()[source]¶: Translate options to Radiance format.

update_from_string(string)[source]¶

Update options from a standard radiance string.

If the option is not currently part of the collection, it will be added to additional_options.

additional_options¶

property command¶: Command name.

property options¶: Print out list of options.

property slots¶: Return slots including the ones from the baseclass if any.

class honeybee_radiance_command.options.optionbase.StringOption(name, description, value=None, valid_values=None, whole=True, pattern_in=None, pattern_out=None)[source]¶

Bases: honeybee_radiance_command.options.optionbase.FileOption

ToString()¶

to_radiance()¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

pattern_in¶

pattern_out¶

valid_values¶

property value¶: Option value.

whole¶

class honeybee_radiance_command.options.optionbase.StringOptionJoined(name, description, value=None, valid_values=None, whole=True, pattern_in=None, pattern_out=None)[source]¶

Bases: honeybee_radiance_command.options.optionbase.StringOption

Joined String Radiance option (e.g.: vtv, fa, etc.).

ToString()¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

pattern_in¶

pattern_out¶

valid_values¶

property value¶: Option value.

whole¶

class honeybee_radiance_command.options.optionbase.ToggleOption(name, description, value=None)[source]¶

Bases: honeybee_radiance_command.options.optionbase.Option

Toggle radiance option.

ToString()¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

property name¶

property value¶: Toggle value.

class honeybee_radiance_command.options.optionbase.TupleOption(name, description, value=None, length=3, numtype=<class 'float'>)[source]¶

Bases: honeybee_radiance_command.options.optionbase.Option

Tuple Radiance option.

ToString()¶

to_radiance()[source]¶: Translate option to Radiance format.

property description¶

property is_set¶: Return True if the value is set by user.

length¶

property name¶

numtype¶

property value¶: Option value.