Stator.
The shared vocabulary of the Stator.AFM API - enumerations and lookup dictionaries
whose values must match what Stator itself uses.
Remarks
Plugins should always use these types rather than hard-coding strings or magic numbers. Values here correspond to the reference lists shown in Stator under Global Options, so a plugin that uses them stays aligned with the host.
Enumerations holds the enumerated types (currency, base type, trading instrument, position type, income event and status). Dictionaries holds methods returning the matching display names and internal identifiers for those enumerations.
Classes
| Dictionaries | Lookup dictionaries which map the Enumerations values onto their Stator display names and internal identifiers. |
| Enumerations | Enumerations to be used when coding against the Stator.AFM API. |
Enumerations
| EnumerationsBaseType | Entire list of available base types |
| EnumerationsCurrency |
Entire list of available currencies
For more information regarding currencies please review international standard 4217 (ISO4217) |
| EnumerationsMarketsIncomeEvent |
Specifies the type of income event, i.e. the dividend was a 'special' dividend Income = dividends, trust distributions |
| EnumerationsMarketsIncomeStatus |
Specifies the status of income event, i.e. what the dividend payout amounted to... Income = dividends, trust distributions |
| EnumerationsMarketsInstrument | A list of market trading instruments (entire list) |
| EnumerationsMarketsPositionType | Specifies the type of the position |