Classes Files

Wombat::MamdaFundamentalListener

MamdaFundamentalListener is a class that specializes in handling fundamental equity pricing/analysis attributes, indicators and ratios. Developers provide their own implementation of the MamdaFundamentalHandler interface and will be delivered notifications for updates in the fundamental data. An obvious application for this MAMDA class is any kind of pricing analysis application. More…

Inherits from Wombat.MamdaMsgListener, Wombat.MamdaFundamentals

Public Functions

  Name
  MamdaFundamentalListener()
Create a specialized fundamental field listener.
void addHandler(MamdaFundamentalHandler handler)
Add a specialized fundamentals handler.
DateTime getSrcTime()
DateTime getActivityTime()
string getCorporateActionType()
Corporate Action Type.
double getDividendPrice()
Dividend price.
string getDividendFrequency()
Frequency of the dividend payments.
string getDividendExDate()
The date on or after which a security is traded without a previously declared dividend or distribution.
string getDividendPayDate()
Date on which corporate action distribution will be paid or effective.
string getDividendRecordDate()
This is the date on which all shareholders are considered a “holder of record” and ensured the right of a dividend or distribution.
string getDividendCurrency()
Currency of dividend.
long getSharesOut()
Shares outstanding. The number of authorized shares in a company that are held by investors, including employees and executives of that company. (Un-issued shares and treasury shares are not included in this figure).
long getSharesFloat()
The number of shares of a security that are outstanding and available for trading by the public.
long getSharesAuthorized()
Authorized shares. The number of shares that a corporation is permitted to issue.
double getEarningsPerShare()
Earnings per share, including common stock, preferred stock, unexercised stock options, unexercised warrants, and some convertible debt. In companies with a large amount of convertibles, warrants and stock options, diluted earnings per share are usually a more accurate measure of the company’s real earning power than earnings per share.
double getVolatility()
The relative rate at which the price of a security moves up and down.
double getPriceEarningsRatio()
The most common measure of how expensive a stock is. The P/E ratio is equal to a stock’s market capitalization divided by its after-tax earnings over a 12-month period, usually the trailing period but occasionally the current or forward period.
double getYield()
Yield, for cash instruments where prices are published
string getMarketSegmentNative()
Feed-specific market segment code in native feed format.
string getMarketSectorNative()
Feed-specific market sector code in native feed format.
string getMarketSegment()
Market subgroup.
string getMarketSector()
A distinct subset of a market, society, industry, or economy, whose components share similar characteristics
double getHistoricalVolatility()
Volatility estimated from historical data
double getRiskFreeRate()
Theoretical interest rate at which an investment may earn interest without incurring any risk
MamdaFieldState getSrcTimeFieldState()
MamdaFieldState getActivityTimeFieldState()
MamdaFieldState getCorporateActionTypeFieldState()
Field State
MamdaFieldState getDividendPriceFieldState()
Field State
MamdaFieldState getDividendFrequencyFieldState()
Field State
MamdaFieldState getDividendExDateFieldState()
Field State
MamdaFieldState getDividendPayDateFieldState()
Field State
MamdaFieldState getDividendRecordDateFieldState()
Field State
MamdaFieldState getDividendCurrencyFieldState()
Field State
MamdaFieldState getSharesOutFieldState()
Field State
MamdaFieldState getSharesFloatFieldState()
Field State
MamdaFieldState getSharesAuthorizedFieldState()
Field State
MamdaFieldState getEarningsPerShareFieldState()
Field State
MamdaFieldState getVolatilityFieldState()
Field State
MamdaFieldState getPriceEarningsRatioFieldState()
Field State
MamdaFieldState getYieldFieldState()
Field State
MamdaFieldState getMarketSegmentNativeFieldState()
Field State
MamdaFieldState getMarketSectorNativeFieldState()
Field State
MamdaFieldState getMarketSegmentFieldState()
Field State
MamdaFieldState getMarketSectorFieldState()
Field State
MamdaFieldState getHistoricalVolatilityFieldState()
Field State
MamdaFieldState getRiskFreeRateFieldState()
Field State
void onMsg(MamdaSubscription subscription, MamaMsg msg, mamaMsgType msgType)
Implementation of MamdaListener interface.
string getFieldAsString(MamaMsgField field)

Detailed Description

class Wombat::MamdaFundamentalListener;

MamdaFundamentalListener is a class that specializes in handling fundamental equity pricing/analysis attributes, indicators and ratios. Developers provide their own implementation of the MamdaFundamentalHandler interface and will be delivered notifications for updates in the fundamental data. An obvious application for this MAMDA class is any kind of pricing analysis application.

Note: The MamdaFundamentalListener class caches equity pricing/analysis attributes, indicators and ratios. Among other reasons, caching of these fields makes it possible to provide complete fundamental callbacks, even when the publisher (e.g., feed handler) is only publishing deltas containing modified fields.

Public Functions Documentation

function MamdaFundamentalListener

MamdaFundamentalListener()

Create a specialized fundamental field listener.

function addHandler

void addHandler(
    MamdaFundamentalHandler handler
)

Add a specialized fundamentals handler.

Parameters:

  • handler

function getSrcTime

DateTime getSrcTime()

function getActivityTime

DateTime getActivityTime()

function getCorporateActionType

string getCorporateActionType()

Corporate Action Type.

Return:

Reimplements: Wombat::MamdaFundamentals::getCorporateActionType

function getDividendPrice

double getDividendPrice()

Dividend price.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendPrice

function getDividendFrequency

string getDividendFrequency()

Frequency of the dividend payments.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendFrequency

  • : No dividend payments are made.
  • 1M : Monthly
  • 3M : Quarterly
  • 6M : Semi-Annually
  • 1Y : Annually
  • SP : Payment frequency is special.
  • NA : Irregular payment frequency.
  • ER : Invalid dividend frequency period.

function getDividendExDate

string getDividendExDate()

The date on or after which a security is traded without a previously declared dividend or distribution.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendExDate

function getDividendPayDate

string getDividendPayDate()

Date on which corporate action distribution will be paid or effective.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendPayDate

function getDividendRecordDate

string getDividendRecordDate()

This is the date on which all shareholders are considered a “holder of record” and ensured the right of a dividend or distribution.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendRecordDate

function getDividendCurrency

string getDividendCurrency()

Currency of dividend.

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendCurrency

function getSharesOut

long getSharesOut()

Shares outstanding. The number of authorized shares in a company that are held by investors, including employees and executives of that company. (Un-issued shares and treasury shares are not included in this figure).

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesOut

function getSharesFloat

long getSharesFloat()

The number of shares of a security that are outstanding and available for trading by the public.

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesFloat

function getSharesAuthorized

long getSharesAuthorized()

Authorized shares. The number of shares that a corporation is permitted to issue.

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesAuthorized

function getEarningsPerShare

double getEarningsPerShare()

Earnings per share, including common stock, preferred stock, unexercised stock options, unexercised warrants, and some convertible debt. In companies with a large amount of convertibles, warrants and stock options, diluted earnings per share are usually a more accurate measure of the company’s real earning power than earnings per share.

Return:

Reimplements: Wombat::MamdaFundamentals::getEarningsPerShare

function getVolatility

double getVolatility()

The relative rate at which the price of a security moves up and down.

Return:

Reimplements: Wombat::MamdaFundamentals::getVolatility

function getPriceEarningsRatio

double getPriceEarningsRatio()

The most common measure of how expensive a stock is. The P/E ratio is equal to a stock’s market capitalization divided by its after-tax earnings over a 12-month period, usually the trailing period but occasionally the current or forward period.

Return:

Reimplements: Wombat::MamdaFundamentals::getPriceEarningsRatio

function getYield

double getYield()

Yield, for cash instruments where prices are published

Return:

Reimplements: Wombat::MamdaFundamentals::getYield

function getMarketSegmentNative

string getMarketSegmentNative()

Feed-specific market segment code in native feed format.

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSegmentNative

function getMarketSectorNative

string getMarketSectorNative()

Feed-specific market sector code in native feed format.

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSectorNative

function getMarketSegment

string getMarketSegment()

Market subgroup.

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSegment

function getMarketSector

string getMarketSector()

A distinct subset of a market, society, industry, or economy, whose components share similar characteristics

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSector

function getHistoricalVolatility

double getHistoricalVolatility()

Volatility estimated from historical data

Return:

Reimplements: Wombat::MamdaFundamentals::getHistoricalVolatility

function getRiskFreeRate

double getRiskFreeRate()

Theoretical interest rate at which an investment may earn interest without incurring any risk

Return:

Reimplements: Wombat::MamdaFundamentals::getRiskFreeRate

function getSrcTimeFieldState

MamdaFieldState getSrcTimeFieldState()

function getActivityTimeFieldState

MamdaFieldState getActivityTimeFieldState()

function getCorporateActionTypeFieldState

MamdaFieldState getCorporateActionTypeFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getCorporateActionTypeFieldState

function getDividendPriceFieldState

MamdaFieldState getDividendPriceFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendPriceFieldState

function getDividendFrequencyFieldState

MamdaFieldState getDividendFrequencyFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendFrequencyFieldState

function getDividendExDateFieldState

MamdaFieldState getDividendExDateFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendExDateFieldState

function getDividendPayDateFieldState

MamdaFieldState getDividendPayDateFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendPayDateFieldState

function getDividendRecordDateFieldState

MamdaFieldState getDividendRecordDateFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendRecordDateFieldState

function getDividendCurrencyFieldState

MamdaFieldState getDividendCurrencyFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getDividendCurrencyFieldState

function getSharesOutFieldState

MamdaFieldState getSharesOutFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesOutFieldState

function getSharesFloatFieldState

MamdaFieldState getSharesFloatFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesFloatFieldState

function getSharesAuthorizedFieldState

MamdaFieldState getSharesAuthorizedFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getSharesAuthorizedFieldState

function getEarningsPerShareFieldState

MamdaFieldState getEarningsPerShareFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getEarningsPerShareFieldState

function getVolatilityFieldState

MamdaFieldState getVolatilityFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getVolatilityFieldState

function getPriceEarningsRatioFieldState

MamdaFieldState getPriceEarningsRatioFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getPriceEarningsRatioFieldState

function getYieldFieldState

MamdaFieldState getYieldFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getYieldFieldState

function getMarketSegmentNativeFieldState

MamdaFieldState getMarketSegmentNativeFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSegmentNativeFieldState

function getMarketSectorNativeFieldState

MamdaFieldState getMarketSectorNativeFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSectorNativeFieldState

function getMarketSegmentFieldState

MamdaFieldState getMarketSegmentFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSegmentFieldState

function getMarketSectorFieldState

MamdaFieldState getMarketSectorFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getMarketSectorFieldState

function getHistoricalVolatilityFieldState

MamdaFieldState getHistoricalVolatilityFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getHistoricalVolatilityFieldState

function getRiskFreeRateFieldState

MamdaFieldState getRiskFreeRateFieldState()

Field State

Return:

Reimplements: Wombat::MamdaFundamentals::getRiskFreeRateFieldState

function onMsg

void onMsg(
    MamdaSubscription subscription,
    MamaMsg msg,
    mamaMsgType msgType
)

Implementation of MamdaListener interface.

Parameters:

  • subscription
  • msg
  • msgType

Reimplements: Wombat::MamdaMsgListener::onMsg

function getFieldAsString

string getFieldAsString(
    MamaMsgField field
)

Updated on 2023-03-31 at 15:30:12 +0100