Skip to content

BH.oM.Adapter.FileSettings

The fileSettings, file name and directory, to use with an adapter for push and pull

Class structure

Implemented interfaces and base types

The FileSettings is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
FileName string The name of the file, including the file extension -
Directory string The folder directory on your computer where the file is to be located. Directory should not include the name of the file. -

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> - -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
GetFullFileName string Queries the full file path to where the file is located on your computer, for use with the file settings - Adapter_Engine

Code and Schema

C# implementation

C#
public class FileSettings : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

Assembly: Adapter_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/Adapter_oM/FileSettings.json"
}

The JSON Schema is available on github here: