Skip to content

BH.oM.Adapters.Robot.InteractiveSettings

Settings controling if Robot should be interactive and vissible during adapter actions.

Class structure

Implemented interfaces and base types

The InteractiveSettings 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
IsInteractive bool If set to false, Robot can not be modified through the UI during an adapter action such as Push and Pull. -
IsVisible bool If set to false, Changes in Robot can not be seen before an adapter action as Push or Pull has completed. -

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

Code and Schema

C# implementation

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

Assembly: Robot_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/Robot_oM/InteractiveSettings.json"
}

The JSON Schema is available on github here: