Package velox.api.layer0.data

Class TextDataMessage

java.lang.Object
velox.api.layer0.data.TextDataMessage
public class TextDataMessage
extends java.lang.Object
Record arbitrary text information that can later be viewed via bookmap. It can be used for attaching any sort of information, e.g. decisions made by your strategy during a test run.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String alias  
    java.lang.String data  
    java.lang.Boolean isBid  
    double price  
    double size  
    java.lang.String source  

  • Constructor Summary

    Constructors 
    Constructor Description
    TextDataMessage​(java.lang.String alias, java.lang.String source, java.lang.Boolean isBid, double price, double size, java.lang.String data)
    Create a new message to record arbitrary text information that can later be viewed via bookmap.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • alias

      public final java.lang.String alias

    • source

      public final java.lang.String source

    • price

      public final double price

    • size

      public final double size

    • isBid

      public final java.lang.Boolean isBid

    • data

      public final java.lang.String data

  • Constructor Details

    • TextDataMessage

      public TextDataMessage​(java.lang.String alias, java.lang.String source, java.lang.Boolean isBid, double price, double size, java.lang.String data)
      Create a new message to record arbitrary text information that can later be viewed via bookmap. It can be used for attaching any sort of information, e.g. decisions made by your strategy during a test run.
      Parameters:
      alias - alias of the instrument this data relates to (null for global data)
      source - source of the event, can be null; Describes what is the origin of event (e.g. "My Indicator 1"), shown by Bookmap when inspecting data
      isBid - true if data is associated with bid side, false - with ask; null if none
      price - price linked to the event, Double.NaN if not applicable
      size - size linked to the event, Double.NaN if not applicable
      data - the data itself; it's not supposed to be processed programmatically, so there are no requirements to it; can be null if you only need other fields; please keep in mind that using excessively long strings will affect performance