Skip to content

BH.oM.Base.Attributes.InputAttribute

Attribute providing information about an input parameter of a method.

Class structure

Implemented interfaces and base types

The InputAttribute 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
Name string Name of the method parameter this attribute corresponds to. -
Description string Description of the correspondent input parameter. -
Classification ClassificationAttribute Classification of the correspondent input parameter, e.g. folder path, quantity etc. -
Exposure UIExposure Information whether the correspondent input parameter is meant to be shown in the UI or not. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
TypeId object - -

Code and Schema

C# implementation

C#
public class InputAttribute : System.Attribute, BH.oM.Base.IImmutable, BH.oM.Base.IObject

Assembly: BHoM.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/BHoM/Attributes/InputAttribute.json"
}

The JSON Schema is available on github here: