Skip to content

BH.oM.Adapters.File.IFSContainer

Identifies a FileSystem-hosted Resource (a File or Directory or other) that holds some content.

Interface structure

Implemented interfaces and base types

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

Classes implementing this interface

The following classes are implementing this interface:

Properties

Derived properties

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

Name Type Description Quantity Engine
IsAcyclic bool Test whether the file hierarchy is acyclic, i.e. has no loops in it. - File_Engine
NestingDepth int Get the nesting depth of the input File or Directory, which is the total number of parent folders. - File_Engine

Code and Schema

C# implementation

C#
public interface IFSContainer : BH.oM.Adapters.File.IFSInfo,
BH.oM.Base.IObject,
BH.oM.Adapters.File.IContainableResource,
BH.oM.Adapters.File.IResource,
BH.oM.Base.IBHoMObject

Assembly: File_oM.dll

The C# interface 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/File_oM/IFSContainer.json"
}

The JSON Schema is available on github here: