Record Class SlippageContext

java.lang.Object
java.lang.Record
com.wualabs.qtsurfer.engine.strategy.backtest.simulation.SlippageContext
Record Components:
side - BUY or SELL
signalPrice - the price the strategy's signal was raised at, before slippage
public record SlippageContext(OrderSide side, BigDecimal signalPrice) extends Record
The inputs a SlippageModel needs to adjust a signal price into an execution price.

  • Constructor Details

    • SlippageContext

      public SlippageContext(OrderSide side, BigDecimal signalPrice)
      Creates an instance of a SlippageContext record class.
      Parameters:
      side - the value for the side record component
      signalPrice - the value for the signalPrice record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • side

      public OrderSide side()
      Returns the value of the side record component.
      Returns:
      the value of the side record component

    • signalPrice

      public BigDecimal signalPrice()
      Returns the value of the signalPrice record component.
      Returns:
      the value of the signalPrice record component