Skip to content

BH.oM.Base.Attributes.ClassificationAttribute

Attribute representing classification of method parameters and object properties, i.e. it tells that a given member is a folder path, quantity etc.

Class structure

Implemented interfaces and base types

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

Classes inheriting from this class

The following classes are inheriting from this class:

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 (not relevant in case of object properties). -

Inherited properties

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

Name Type Description Quantity
TypeId object - -

Derived properties

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

Name Type Description Quantity Engine
IDescription string Return the custom description of a classification attribute. - Reflection_Engine

Code and Schema

C# implementation

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

Assembly: BHoM.dll

The C# abstract 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/ClassificationAttribute.json"
}

The JSON Schema is available on github here: