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

A message that indicates to clear all orders in the order book. More...

#include <messages.hpp>

Public Member Functions

 Clear (SequenceNumber sequence=0, TimeStamp time=0)
 Initialize a new clear book 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
 

Friends

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

Detailed Description

A message that indicates to clear all orders in the order book.

Clear Message

Constructor & Destructor Documentation

◆ Clear()

DataFeed::Messages::Clear::Clear ( SequenceNumber  sequence = 0,
TimeStamp  time = 0 
)
inline

Initialize a new clear book message.

Parameters
sequencethe sequence number for the message
timethe time for the message

Member Function Documentation

◆ to_string()

std::string DataFeed::Messages::Clear::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 Clear 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: