CBOE Emulator  1.0
Public Member Functions | Public Attributes | Friends | List of all members
DataFeed::Messages::Trade Struct Reference

A message that indicates a market order matches with a limit order. More...

#include <messages.hpp>

Public Member Functions

 Trade (OrderID uid_, Price price_, Quantity quantity_, Side side_, SequenceNumber sequence=0, TimeStamp time=0)
 Initialize a new trade message. More...
 
std::string to_string () const
 Convert the object to an STL string. More...
 

Public Attributes

const Header header
 the message header that defines the template ID and length of message
 
const OrderID uid
 the MessageID for the limit order that matched
 
const Price price
 the execution price for the trade
 
const Quantity quantity
 the quantity of the trade
 
const Side side
 the side of the market order
 

Friends

std::ostream & operator<< (std::ostream &stream, const Trade &message)
 Write the data from the message to a stream. More...
 

Detailed Description

A message that indicates a market order matches with a limit order.

Trade Message

Constructor & Destructor Documentation

◆ Trade()

DataFeed::Messages::Trade::Trade ( OrderID  uid_,
Price  price_,
Quantity  quantity_,
Side  side_,
SequenceNumber  sequence = 0,
TimeStamp  time = 0 
)
inline

Initialize a new trade message.

Parameters
uid_the MessageID for the limit order that matched
price_the execution price for the trade
quantity_the quantity of the trade
side_the side of the market order
sequencethe sequence number for the message
timethe time for the message

Member Function Documentation

◆ to_string()

std::string DataFeed::Messages::Trade::to_string ( ) const
inline

Convert the object to an STL string.

Returns
a string representation of the object

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const Trade message 
)
friend

Write the data from the message to a stream.

Parameters
streamthe stream to write the data to
messagethe message to write to the stream
Returns
the stream with data from the message written to it

The documentation for this struct was generated from the following file: