/usr/include/mamda/MamdaTradeReport.h is in libmamda-dev 2.2.2.1-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef MamdaTradeReportH
#define MamdaTradeReportH
#include <mamda/MamdaConfig.h>
#include <mamda/MamdaBasicEvent.h>
#include <mamda/MamdaFieldState.h>
namespace Wombat
{
/**
* MamdaTradeReport is an interface that provides access to fields
* related to a trade report. This class is used for all trade
* reports, whether those trades qualify as regular or irregular
* trades. (A regular trade generally qualifies to update the
* official last price and intraday high/low prices.)
*/
class MAMDAExpDLL MamdaTradeReport : public MamdaBasicEvent
{
public:
/**
* Get the trade price.
* @return The monetary value of an individual share of the
* security at the time of the trade.
*/
virtual const MamaPrice& getTradePrice() const = 0;
/**
* Get the volume of shares in the trade.
* @return The number of shares traded in a single transaction for
* an individual security.
*/
virtual mama_quantity_t getTradeVolume() const = 0;
/**
* Get the participant identifier for the trade.
* @return Trade participant ID. This is typically an exchange ID
* or a market maker ID.
*/
virtual const char* getTradePartId() const = 0;
/**
* Get the NYSE Technologies normalized trade qualifier.
* @return Trade qualifier. A normalized set of qualifiers for
* the current trade for the security. This field may contain
* multiple string values, separated by the colon(:) character.
*
* <table width="100%" border="1">
* <tr><td><b>Value</b></td><td><b>Meaning</b></td></tr>
* <tr>
* <td>Normal</td>
* <td>Regular trade. A trade made without stated conditions
* is deemed regular way for settlement on the third *
* business day following the transaction * date.</td>
* </tr>
* <tr>
* <td>Acquisition</td>
* <td>A transaction made on the Exchange as a result of an
* Exchange acquisition.</td>
* </tr>
* <tr>
* <td>Bunched</td>
* <td>A trade representing an aggregate of two or more
* regular trades in a security occurring at the same price
* either simultaneously or within the same 60 second period,
* with no individual trade exceeding 10,000 shares.</td>
* </tr>
* <tr>
* <td>Cash</td>
* <td>A transaction which calls for the delivery of
* securities and payment on the same day the trade takes
* place.</td>
* </tr>
* <tr>
* <td>Distribution</td>
* <td>Sale of a large block of stock in such a manner that
* the price is not adversely affected.</td>
* </tr>
* <tr>
* <td>BunchedSold</td>
* <td>A bunched trade which is reported late</td>
* </tr>
* <tr>
* <td>Rule155</td>
* <td>To qualify as a 155 print, a specialist arranges for
* the sale of the block at one "clean-up" price or
* at the different price limits on his book. If the block is
* sold at a "clean-up" price, the specialist should execute
* at the same price all the executable buy orders on his
* book. The sale qualifier is only applicable for AMEX
* trades.</td>
* </tr>
* <tr>
* <td>SoldLast</td>
* <td>Sold Last is used when a trade prints in sequence but
* is reported late or printed in conformance to the One or
* Two Point Rule.</td>
* </tr>
* <tr>
* <td>NextDay</td>
* <td>A transaction which calls for delivery of securities on
* the first business day after the trade date.</td>
* </tr>
* <tr>
* <td>Opened</td>
* <td>Indicates an opening transaction that is printed out of
* sequence or reported late or printed in conformance to the
* One or Two Point Rule.</td>
* </tr>
* <tr>
* <td>PriorRef</td>
* <td>An executed trade that relates to an obligation to
* trade at an earlier point in the trading day or that refer
* to a prior reference price. This may be the result of an
* order that was lost or misplaced or a SelectNet order that
* was not executed on a timely basis.</td>
* </tr>
* <tr>
* <td>Seller</td>
* <td>A Seller's option transaction is a special transaction
* which gives the seller the right to deliver the stock at
* any time within a specific period, ranging from not less
* than four calendar days to no more than 60 calendar
* days.</td>
* </tr>
* <tr>
* <td>SplitTrade</td>
* <td>An execution in two markets when the specialist or
* Market Maker in the market first receiving the order agrees
* to execute a portion of it at whatever price is realized in
* another market to which the balance of the order is
* forwarded for execution.</td>
* </tr>
* <tr>
* <td>FormT</td>
* <td>See PrePostMkt. Currently, all feed handlers that post
* Form-T trades - except CTA - send this qualifier for Form-T
* trades. In the next major release, all fields will use
* PrePostMkt and FormT will be obsolete.</td>
* </tr>
* <tr>
* <td>PrePostMkt</td>
* <td>A trade reported before or after the normal trade
* reporting day. This is also known as a Form-T trade. The
* volume of Form-T trades will be included in the calculation
* of total volume. The price information in Form-T trades
* will not be used to update high, low and last sale data for
* individual securities or Indices since they occur outside
* of normal trade reporting hours. Currently, all feed
* handlers that post Form-T trades - except CTA - send the
* "FormT" qualifier for Fot-T trades. In the next major
* release, all feed handlers will use PrePostMkt and FormT
* will be obsolete.</td>
* </tr>
* <tr>
* <td>AvPrice</td>
* <td>A trade where the price reported is based upon an
* average of the prices for transactions in a security during
* all or any portion of the trading day.</td>
* </tr>
* <tr>
* <td>Sold</td>
* <td>Sold is used when a trade is printed (reported) out of
* sequence and at a time different from the actual
* transaction time.</td>
* </tr>
* <tr>
* <td>Adjusted</tr>
* <td> </td>
* </tr>
* <tr>
* <td>Auto</td>
* <td>A sale condition code that identifies a NYSE trade that
* has been automatically executed without the potential
* benefit of price improvement. </td>
* </tr>
* <tr>
* <td>Basket</td>
* <td> </td>
* </tr>
* <tr>
* <td>CashOnly</td>
* <td> </td>
* </tr>
* <tr>
* <td>NextDayOnly</td>
* <td> </td>
* </tr>
* <tr>
* <td>SpecTerms</td>
* <td> </td>
* </tr>
* <tr>
* <td>Stopped</td>
* <td> </td>
* </tr>
* <tr>
* <td>CATS</td>
* <td> </td>
* </tr>
* <tr>
* <td>VCT</td>
* <td> </td>
* </tr>
* <tr>
* <td>Rule127</td>
* <td> </td>
* </tr>
* <tr>
* <td>BurstBasket</td>
* <td>A burst basket execution signifies a trade wherein the
* equity Specialists, acting in the aggregate as a market
* maker, purchase or sell the component stocks required for
* execution of a specific basket trade.</td>
* </tr>
* <tr>
* <td>OpenDetail</td>
* <td>Opening trade detail message. Sent by CTS only and is
* a duplicate report of an earlier trade. Note: since feed
* handler version 2.14.32, it is configurable whether these
* detail messages are published.</td>
* </tr>
* <tr>
* <td>Detail</td>
* <td>Trade detail message. Sent by CTS only and is a
* duplicate report of an earlier trade. Note: since feed
* handler version 2.14.32, it is configurable whether these
* detail messages are published.</td>
* </tr>
* <tr>
* <td>Reserved</td>
* <td> </td>
* </tr>
* <tr>
* <td>BasketCross</td>
* <td> </td>
* </tr>
* <tr>
* <td>BasketIndexOnClose</td>
* <td>A basket index on close transaction signifies a trade involving
* paired basket orders,the execution of which is based on the closing
* value of the index. These trades are reported after the close when
* the index closing value is determined.</td>
* </tr>
* <tr>
* <td>IntermarketSweep</td>
* <td>Indicates to CTS data recipients that the execution price
* reflects the order instruction not to send the order to another
* market that may have a superior price.</td>
* </tr>
* <tr>
* <td>YellowFlag</td>
* <td>Regular trades reported during specific events as out of the
* ordinary.</td>
* </tr>
* <tr>
* <td>MarketCenterOpen</td>
* <td> </td>
* </tr>
* <tr>
* <td>MarketCenterClose</td>
* <td> </td>
* </tr>
* <tr>
* <td>Unknown</td>
* <td> </td>
* </tr>
* </table>
*/
virtual const char* getTradeQual() const = 0;
/**
* Get the native feed trade qualifier.
* @return Native trade qualifier (a.k.a. "sale condition").
* Feed-specific trade qualifier code(s). This field is provided
* primarily for completeness and/or troubleshooting.
* @see getTradeQual.
*/
virtual const char* getTradeQualNative() const = 0;
/**
* @return the Aggressor Side or TradeSide
* TradeSide
* <ul>
* <li>0 : No TradeSide is currently known/available.</li>
* <li>1 or B : Buy</li>
* <li>2 or S : Sell</li>
* <ul>
* AggressorSide
* <ul>
* <li>0 : No AggressorSide is currently known/available.</li>
* <li>1 or B : Buy</li>
* <li>2 or S : Sell</li>
* <ul>
*/
virtual const char* getSide() const = 0;
/**
* The TradeSide or AggressorSide Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getSideFieldState() const = 0;
/**
* Get the trade sellers sale days.
* @return Seller's sale days. Used when the trade qualifier is
* "Seller". Specifies the number of days that may elapse before
* delivery of the security.
*/
virtual mama_u32_t getTradeSellersSaleDays() const = 0;
/**
* Get the trade stop stock indicator.
* @return Stopped stock indicator. Condition related to certain
* NYSE trading rules. This is not related to a halted security
* status. (0 == N/A; 1 == Applicable)
*/
virtual char getTradeStopStock() const = 0;
/**
* Get whether the trade is irregular.
* @return Whether or not the trade qualifies as an irregular
* trade. In general, only "regular" trades qualify to update the
* official last price and high/low prices.
*/
virtual bool getIsIrregular() const = 0;
/**
* Get the order id, if available.
* @return The trade message unique order id number (if available).
*/
virtual mama_u64_t getOrderId() const = 0;
/**
* Get the unique ID
* @return The unique ID
*/
virtual const char* getUniqueId() const = 0;
/**
* Get the trade action
* @return The trade action
*/
virtual const char* getTradeAction() const = 0;
/**
* Get the trade id
* @return the trade id
*/
virtual const char* getTradeId() const = 0;
/**
* get the ShortSaleCircuitBreaker
* @return ShortSaleCircuitBreaker
* <ul>
* <li>return values:</li>
* <li>Blank: Short Sale Restriction Not in Effect.</li>
* <li>A: Short Sale Restriction Activiated.</li>
* <li>C: Short Sale Restriction Continued.</li>
* <li>D: Sale Restriction Deactivated.</li>
* <li>E: Sale Restriction in Effect.</li>
* </ul>
*/
virtual char getShortSaleCircuitBreaker() const=0;
/* FieldState Accesors */
/**
* The trade price Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradePriceFieldState() const = 0;
/**
* The trade volume Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeVolumeFieldState() const = 0;
/**
* The trade part ID Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradePartIdFieldState() const = 0;
/**
* The trade qual Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeQualFieldState() const = 0;
/**
* The trade quality native Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeQualNativeFieldState() const = 0;
/**
* The trade sellers sale days Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeSellersSaleDaysFieldState() const = 0;
/**
* The trade stop stock Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeStopStockFieldState() const = 0;
/**
* The isIrregular Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getIsIrregularFieldState() const = 0;
/**
* The order ID Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getOrderIdFieldState() const = 0;
/**
* The unique ID Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getUniqueIdFieldState() const = 0;
/**
* The trade action Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeActionFieldState() const = 0;
/**
* The trade ID Field State.
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getTradeIdFieldState() const = 0;
/**
* @return MamdaFieldState. An enumeration representing field state.
*/
virtual MamdaFieldState getShortSaleCircuitBreakerFieldState() const = 0;
virtual ~MamdaTradeReport() {};
};
} // namespace
#endif // MamdaTradeReportH
|