public class Underlying extends MarketEvent implements LastingEvent<String>
Underlying event has the following properties:
eventSymbol - symbol of this event;
volatility - 30-day implied volatility for this underlying based on VIX methodology;
frontVolatility - front month implied volatility for this underlying based on VIX methodology;
backVolatility - 3back month implied volatility for this underlying based on VIX methodology;
putCallRatio - ratio of put traded volume to call traded volume for a day.
See the model section for a mathematical background on the values in this event.
Underlying.| Constructor and Description |
|---|
Underlying()
Creates new underlying event with default values.
|
Underlying(String eventSymbol)
Creates new underlying event with the specified event symbol.
|
| Modifier and Type | Method and Description |
|---|---|
double |
getBackVolatility()
Returns back month implied volatility for this underlying based on VIX methodology.
|
double |
getFrontVolatility()
Returns front month implied volatility for this underlying based on VIX methodology.
|
double |
getPutCallRatio()
Returns ratio of put traded volume to call traded volume for a day.
|
double |
getVolatility()
Returns 30-day implied volatility for this underlying based on VIX methodology.
|
void |
setBackVolatility(double backVolatility)
Changes back month implied volatility for this underlying based on VIX methodology.
|
void |
setFrontVolatility(double frontVolatility)
Changes front month implied volatility for this underlying based on VIX methodology.
|
void |
setPutCallRatio(double putCallRatio)
Changes ratio of put traded volume to call traded volume for a day.
|
void |
setVolatility(double volatility)
Changes 30-day implied volatility for this underlying based on VIX methodology.
|
String |
toString()
Returns string representation of this underlying event.
|
protected String |
underlyingFieldsToString() |
getEventSymbol, setEventSymbolclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetEventSymbol, setEventSymbolpublic Underlying()
public Underlying(String eventSymbol)
eventSymbol - event symbol.public double getVolatility()
public void setVolatility(double volatility)
volatility - 30-day implied volatility for this underlying based on VIX methodology.public double getFrontVolatility()
public void setFrontVolatility(double frontVolatility)
frontVolatility - front month implied volatility for this underlying based on VIX methodology.public double getBackVolatility()
public void setBackVolatility(double backVolatility)
backVolatility - back month implied volatility for this underlying based on VIX methodology.public double getPutCallRatio()
public void setPutCallRatio(double putCallRatio)
putCallRatio - ratio of put traded volume to call traded volume for a day.protected String underlyingFieldsToString()
Copyright © 2016 Devexperts. All Rights Reserved.