trading_core::CancelOrder Class Reference

A command to cancel an existing order in the trading engine. More...

#include <CancelOrder.h>

Inheritance diagram for trading_core::CancelOrder:

Collaboration diagram for trading_core::CancelOrder:

Public Member Functions
	CancelOrder (const common::ClientID &clientId, const common::Timestamp timestamp, const common::OrderID orderId)
	Constructs a new CancelOrder command.
common::ClientID	getClientId () const
	Gets the client's identifier.
common::OrderID	getOrderId () const
	Gets the ID of the order to be cancelled.
common::Timestamp	getTimestamp () const
	Gets the command's timestamp.
CommandType	getType () const
	Gets the type of the command.

Private Attributes
common::ClientID	mClientId
common::OrderID	mOrderId
	The ID of the order to be cancelled.
common::Timestamp	mTimestamp
	The timestamp of when the command was created.
CommandType	mType
	The type of the command.

Detailed Description

A command to cancel an existing order in the trading engine.

This class derives from the base Command class and encapsulates the data required to cancel an order, including the order ID.

Constructor & Destructor Documentation

CancelOrder()

trading_core::CancelOrder::CancelOrder ( const common::ClientID &  clientId, const common::Timestamp  timestamp, const common::OrderID  orderId  )

inlineexplicit

Constructs a new CancelOrder command.

Parameters

clientId	The identifier of the client cancelling the order.
timestamp	The time at which the command was created.
orderId	The ID of the order to be cancelled.

Member Function Documentation

getClientId()

common::ClientID trading_core::Command::getClientId ( ) const

inlineinherited

Gets the client's identifier.

Here is the caller graph for this function:

getOrderId()

common::OrderID trading_core::CancelOrder::getOrderId ( ) const

inline

Gets the ID of the order to be cancelled.

Here is the caller graph for this function:

getTimestamp()

common::Timestamp trading_core::Command::getTimestamp ( ) const

inlineinherited

Gets the command's timestamp.

getType()

CommandType trading_core::Command::getType ( ) const

inlineinherited

Gets the type of the command.

Member Data Documentation

mClientId

common::ClientID trading_core::Command::mClientId

privateinherited

The identifier of the client sending the command.

mOrderId

common::OrderID trading_core::CancelOrder::mOrderId

private

The ID of the order to be cancelled.

mTimestamp

common::Timestamp trading_core::Command::mTimestamp

privateinherited

The timestamp of when the command was created.

mType

CommandType trading_core::Command::mType

privateinherited

The type of the command.

---

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

• core/trading_core/include/trading_core/CancelOrder.h