BH.oM.EmbodiedSuffering.Elements.MaterialImportSources¶
An Embodied Suffering object used for defining the import ratios per country for a particular material, utilised in a specific country (e.g. the United States gets all of its timber from Brazil, or that it is 50% from Brazil and 50% from Vietnam.)
Class structure¶
Implemented interfaces and base types¶
The MaterialImportSources is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
Material | Material | The name of the material that is imported to a particular country from other countries. | - |
ExportCountries | List<Country> | List of countries from which the material was imported. Count should match the import ratios. | - |
ImportRatios | List<double> | List of material import ratios from each country. For example, if Brazil is the sole country of import for timber the value would be 1.0, if the United Kingdom is responsible for 50% of the imports of steel to a particular country that value would be 0.5. The values do not necessarily need to add to 1.0. Count should match the ExportCountries. | - |
ImportCountry | Country | The name of the country in which the imported materials are utilised. | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
CustomData | Dictionary<string, object> | - | - |
Code and Schema¶
C# implementation¶
C#
public class MaterialImportSources : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject
Assembly: EmbodiedSuffering_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/EmbodiedSuffering_oM/Elements/MaterialImportSources.json"
}
The JSON Schema is available on github here: