Skip to content

Commit

Permalink
Order: ✅
Browse files Browse the repository at this point in the history
  • Loading branch information
kosyloa committed Oct 12, 2023
1 parent 77507b6 commit de87ef6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
22 changes: 20 additions & 2 deletions DXFeedFramework/Events/Market/Order.swift
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,25 @@
//

import Foundation

/// Order event is a snapshot for a full available market depth for a symbol.
///
/// The collection of order events of a symbol represents the most recent information
/// that is available about orders on the market at any given moment of time.
/// Order events give information on several levels of details, called scopes - see ``Scope``.
/// Scope of an order is available via ``OrderBase.Scope``property.
///
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/event/market/Order.html)
public class Order: OrderBase {

/// Gets or sets market maker or other aggregate identifier of this order.
/// This value is defined for ``Scope/aggregate`` and ``Scope/order`` orders.
public var marketMaker: String?

/// Returns string representation of this candle event.
override func toString() -> String {
return
"""
Order{\(baseFieldsToString()), \
marketMaker=\(marketMaker ?? "null")}
"""
}
}
11 changes: 6 additions & 5 deletions DXFeedFramework/Events/Market/SpreadOrder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ import Foundation
/// The collection of spread order events of a symbol
/// represents the most recent information that is available about spread orders on
/// the market at any given moment of time.
/// <para> Spread order is similar to a regular <see cref="Order"/>, but it has a
/// <see cref="SpreadSymbol"/> property that contains the symbol
///
/// Spread order is similar to a regular ``Order``, but it has a
/// ``SpreadSymbol`` property that contains the symbol
/// of the actual spread that is being represented by spread order object.
/// <see cref="MarketEvent.EventSymbol"/> property contains the underlying symbol
/// ``MarketEvent.EventSymbol`` property contains the underlying symbol
/// that was used in subscription.
/// </para>
/// For more details see <a href="https://docs.dxfeed.com/dxfeed/api/com/dxfeed/event/market/SpreadOrder.html">Javadoc</a>.
///
/// [For more details see](https://docs.dxfeed.com/dxfeed/api/com/dxfeed/event/market/SpreadOrder.html)
public class SpreadOrder: OrderBase {

/// Gets or sets spread symbol of this event.
Expand Down

0 comments on commit de87ef6

Please sign in to comment.