Package velox.api.layer1.messages

Class Layer1ApiSetBracketsMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

velox.api.layer1.messages.Layer1ApiSetBracketsMessage

public final class Layer1ApiSetBracketsMessage
extends Layer1ApiTradingMessageWithCallback

Request to change the Brackets settings in the Trading Control Panel.
Send via Layer1ApiAdminProvider.sendUserMessage(Object)

This message is only processed if it was sent from a trading strategy (see Layer1TradingStrategy).

Works only when the Trading Control Panel is enabled.

See Also:

• Layer1ApiGetBracketsMessage

Nested Class Summary

Nested classes/interfaces inherited from class velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

Layer1ApiTradingMessageWithCallback.Response, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	enabled
final int	stopLossOffset
final int	takeProfitOffset

Fields inherited from class velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

alias, listener

Constructor Summary

Constructors

Constructor	Description
Layer1ApiSetBracketsMessage(String alias, int takeProfitOffset, int stopLossOffset, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)	Creates a message to enable brackets with the given take-profit and stop-loss offsets.
Layer1ApiSetBracketsMessage(String alias, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)	Creates a message to disable brackets.

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

enabled

public final boolean enabled

takeProfitOffset

public final int takeProfitOffset

stopLossOffset

public final int stopLossOffset

Constructor Details

Layer1ApiSetBracketsMessage

public Layer1ApiSetBracketsMessage(String alias,
 int takeProfitOffset,
 int stopLossOffset,
 Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Creates a message to enable brackets with the given take-profit and stop-loss offsets.

At least one of takeProfitOffset or stopLossOffset must be greater than 0 - enabling brackets without any leg is meaningless. To turn brackets off, use Layer1ApiSetBracketsMessage(String, TradingMessageResponseListener) instead.

Parameters:

takeProfitOffset - take-profit offset in ticks (>= 0, 0 means take-profit is not set)

stopLossOffset - stop-loss offset in ticks (>= 0, 0 means stop-loss is not set)

Throws:

IllegalArgumentException - if either offset is negative, or if both offsets are 0

Layer1ApiSetBracketsMessage

public Layer1ApiSetBracketsMessage(String alias,
 Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Creates a message to disable brackets. Take-profit and stop-loss offsets are not applicable and are set to 0.

Method Details

toString

public String toString()

Overrides:

toString in class Object