Loading...
Searching...
No Matches
ATAS.Indicators.Modules.PlatformModuleAttribute Class Reference

Marks a class derived from PlatformModule as a custom module and supplies its discovery metadata. The platform lists only modules that carry this attribute. More...

Inheritance diagram for ATAS.Indicators.Modules.PlatformModuleAttribute:
[legend]
Collaboration diagram for ATAS.Indicators.Modules.PlatformModuleAttribute:
[legend]

Public Member Functions

 PlatformModuleAttribute (string id)
 

Properties

string Id [get]
 Stable module identifier, e.g. "mycompany.tape-speed": <vendor>.<module-name> in lowercase letters, digits and dashes. The platform saves the module in workspaces under this identifier, so it must never change once the module is released. The vendor atas is reserved.
 
string? DisplayName [get]
 Name shown in the menu of custom modules and as the panel title. If omitted, the class name is used.
 

Detailed Description

Marks a class derived from PlatformModule as a custom module and supplies its discovery metadata. The platform lists only modules that carry this attribute.

Constructor & Destructor Documentation

◆ PlatformModuleAttribute()

ATAS.Indicators.Modules.PlatformModuleAttribute.PlatformModuleAttribute ( string  id)

Property Documentation

◆ DisplayName

string? ATAS.Indicators.Modules.PlatformModuleAttribute.DisplayName
get

Name shown in the menu of custom modules and as the panel title. If omitted, the class name is used.

◆ Id

string ATAS.Indicators.Modules.PlatformModuleAttribute.Id
get

Stable module identifier, e.g. "mycompany.tape-speed": <vendor>.<module-name> in lowercase letters, digits and dashes. The platform saves the module in workspaces under this identifier, so it must never change once the module is released. The vendor atas is reserved.


The documentation for this class was generated from the following file: