Skip to content

BH.oM.Base.Attributes.OutputAttribute

Attribute providing information about an output parameter of a method. To be applied to all methods that do not return void nor BH.oM.Base.Output types.

Class structure

Implemented interfaces and base types

The OutputAttribute 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 correspondent output parameter (to be used in the UI). -
Description string Description of the correspondent output parameter. -
Classification ClassificationAttribute Classification of the correspondent output parameter, e.g. folder path, quantity etc. -

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 OutputAttribute : 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/OutputAttribute.json"
}

The JSON Schema is available on github here: