Wombat::MamdaNewsHeadline Class Reference

MamdaNewsHeadline represents a news headline and includes information about many types of meta-data attributes associated with the headline. More...

#include <MamdaNewsHeadline.h>

Inheritance diagram for Wombat::MamdaNewsHeadline:

Public Member Functions
	MamdaNewsHeadline ()
	Default constructor. More...
	MamdaNewsHeadline (const MamdaNewsHeadline &copy)
	Copy constructor. More...
virtual	~MamdaNewsHeadline ()
	Destructor. More...
virtual MamdaNewsHeadline &	operator= (const MamdaNewsHeadline &rhs)
	Assignment operator. More...
virtual const char *	getHeadlineText () const
virtual MamdaNewsHeadlineId	getHeadlineId () const
virtual MamdaNewsStoryId	getNewsStoryId () const
virtual MamdaNewsStoryId	getNewsOrigStoryId () const
virtual bool	getNewsHasStory () const
virtual const char *	getNewsSourceId () const
virtual const char *	getNewsOrigSourceId () const
virtual const char *	getLanguageId () const
virtual void	getNativeCodes (const char **&codes, mama_size_t &numCodes) const
	Get an array of native meta-data codes associated with this news story. More...
virtual void	getNativeRelatedSymbols (const char **&symbols, mama_size_t &numSymbols) const
	Get an array of native feed symbol codes associated with this news story. More...
virtual void	getIndustries (const char **&industries, mama_size_t &numIndustries) const
	Get an array of normalized industry codes associated with this news story. More...
virtual void	getMarketSectors (const char **&marketSectors, mama_size_t &numMarketSectors) const
	Get an array of normalized market sector codes associated with this news story. More...
virtual void	getRegions (const char **&regions, mama_size_t &numRegions) const
	Get an array of normalized region codes associated with this news story. More...
virtual void	getCountries (const char **&countries, mama_size_t &numCountries) const
	Get an array of ISO country codes associated with this news story. More...
virtual void	getProducts (const char **&products, mama_size_t &numProducts) const
	Get an array of normalized product codes associated with this news story. More...
virtual void	getTopics (const char **&topics, mama_size_t &numTopics) const
	Get an array of normalized topic (or "subject") codes associated with this news story. More...
virtual void	getMiscCodes (const char **&miscCodes, mama_size_t &numMiscCodes) const
	Get an array of normalized miscellaneous codes associated with this news story. More...
virtual void	getRelatedSymbols (const char **&symbols, mama_size_t &numSymbols) const
	Get an array of normalized symbol codes associated with this news story. More...
virtual MamdaNewsPriority	getNewsPriority () const
virtual mama_u16_t	getNewsStoryRevNumber () const
virtual const MamaDateTime &	getNewsOrigStoryTime () const
virtual const char *	getSymbol () const
	Get the instruments string symbol. More...
virtual const char *	getPartId () const
	Get the participant identifier. More...
virtual const MamaDateTime &	getSrcTime () const
	Get the source time. More...
virtual const MamaDateTime &	getActivityTime () const
	Get the activity time. More...
virtual const MamaDateTime &	getLineTime () const
	Get the line time. More...
virtual const MamaDateTime &	getSendTime () const
	Get the send time. More...
virtual const MamaMsgQual &	getMsgQual () const
	Get the message qualifier. More...
virtual const MamaDateTime &	getEventTime () const
	Get the event time. More...
virtual mama_seqnum_t	getEventSeqNum () const
	Get the event sequence number. More...
MamdaFieldState	getSymbolFieldState () const
	Get the string symbol field state. More...
MamdaFieldState	getPartIdFieldState () const
	Get the participant identifier field state. More...
MamdaFieldState	getSrcTimeFieldState () const
	Get the source time field state. More...
MamdaFieldState	getActivityTimeFieldState () const
	Get the activity time field state. More...
MamdaFieldState	getLineTimeFieldState () const
	Get the line time of the update. More...
MamdaFieldState	getSendTimeFieldState () const
	Get the send time field state. More...
MamdaFieldState	getMsgQualFieldState () const
	Get the message qualifier field state. More...
MamdaFieldState	getEventTimeFieldState () const
	Get the event time field state. More...
MamdaFieldState	getEventSeqNumFieldState () const
	Get the event sequence number field state. More...
void	setHeadlineText (const char *headlineText)
void	setHeadlineId (const char *headlineId)
void	setStoryId (const char *storyId)
void	setHasStory (bool hasStory)
void	setSourceId (const char *source)
void	setOrigStoryId (const char *storyId)
void	setOrigSourceId (const char *origSourceId)
void	setLanguageId (const char *langId)
void	setNativeCodes (const char **codes, mama_size_t numCodes)
void	setNativeRelatedSymbols (const char **symbols, mama_size_t numSymbols)
void	setIndustries (const char **industries, mama_size_t numIndustries)
void	setMarketSectors (const char **marketSectors, mama_size_t numMarketSectors)
void	setRegions (const char **regions, mama_size_t numRegions)
void	setCountries (const char **countries, mama_size_t numCountries)
void	setProducts (const char **products, mama_size_t numProducts)
void	setTopics (const char **topics, mama_size_t numTopics)
void	setMiscCodes (const char **codes, mama_size_t numCodes)
void	setRelatedSymbols (const char **symbols, mama_size_t numSymbols)
void	setPriority (MamdaNewsPriority priority)
void	setStoryRevNumber (mama_u16_t storyRevNum)
void	setEventSeqNum (mama_seqnum_t seqNum)
void	setEventTime (const MamaDateTime &eventTime)
void	setOrigStoryTime (const MamaDateTime &storyTime)
void	setSrcTime (const MamaDateTime &srcTime)
void	setActivityTime (const MamaDateTime &actTime)
void	setLineTime (const MamaDateTime &lineTime)
void	setSendTime (const MamaDateTime &sendTime)
void	setMsgQual (const MamaMsgQual &msgQualifier)
void	clear ()
void	setSubscriptionInfo (MamdaSubscription *subsc)
	Implementation: save the subscription info for the headline (so we know where to request stories from). More...
void	setSubscInfo (MamaQueue *queue, MamaSource *source)
MamaQueue *	getQueue () const
	Implementation: get the subscription info for the headline. More...
MamaSource *	getSource () const
Public Member Functions inherited from Wombat::MamdaNewsMetaData
virtual	~MamdaNewsMetaData ()
Public Member Functions inherited from Wombat::MamdaBasicEvent
virtual	~MamdaBasicEvent ()
	Destructor. More...

Detailed Description

MamdaNewsHeadline represents a news headline and includes information about many types of meta-data attributes associated with the headline.

Note on story IDs: all headlines have a story ID, even though no story may exist for the headline. The story ID is generated in order to be able to index together all revisions of a headline/story over time.

Constructor & Destructor Documentation

MamdaNewsHeadline() [1/2]

Wombat::MamdaNewsHeadline::MamdaNewsHeadline

(

)

Default constructor.

MamdaNewsHeadline() [2/2]

Wombat::MamdaNewsHeadline::MamdaNewsHeadline

(

const MamdaNewsHeadline &

copy

)

Copy constructor.

~MamdaNewsHeadline()

virtual Wombat::MamdaNewsHeadline::~MamdaNewsHeadline ( )

virtual

Destructor.

Member Function Documentation

operator=()

virtual MamdaNewsHeadline& Wombat::MamdaNewsHeadline::operator= ( const MamdaNewsHeadline &  rhs )

virtual

Assignment operator.

getHeadlineText()

virtual const char* Wombat::MamdaNewsHeadline::getHeadlineText ( ) const

virtual

Returns

The text of the headline for the story.

Implements Wombat::MamdaNewsMetaData.

getHeadlineId()

virtual MamdaNewsHeadlineId Wombat::MamdaNewsHeadline::getHeadlineId ( ) const

virtual

Returns

The headline ID for this headline.

getNewsStoryId()

virtual MamdaNewsStoryId Wombat::MamdaNewsHeadline::getNewsStoryId ( ) const

virtual

Returns

The NYSE Technologies ID of the news story.

getNewsOrigStoryId()

virtual MamdaNewsStoryId Wombat::MamdaNewsHeadline::getNewsOrigStoryId ( ) const

virtual

Returns

The data source story ID for this news story.

getNewsHasStory()

virtual bool Wombat::MamdaNewsHeadline::getNewsHasStory ( ) const

virtual

Returns

Whether the headline has an associated story at this time.

getNewsSourceId()

virtual const char* Wombat::MamdaNewsHeadline::getNewsSourceId ( ) const

virtual

Returns

The data source of the news story.

Implements Wombat::MamdaNewsMetaData.

getNewsOrigSourceId()

virtual const char* Wombat::MamdaNewsHeadline::getNewsOrigSourceId ( ) const

virtual

Returns

The original data source of the news story (e.g., if the story was provided by a news aggregator).

Implements Wombat::MamdaNewsMetaData.

getLanguageId()

virtual const char* Wombat::MamdaNewsHeadline::getLanguageId ( ) const

virtual

Returns

The ANSI language ID of the news story.

Implements Wombat::MamdaNewsMetaData.

getNativeCodes()

virtual void Wombat::MamdaNewsHeadline::getNativeCodes ( const char **&  codes, mama_size_t &  numCodes  ) const

virtual

Get an array of native meta-data codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getNativeRelatedSymbols()

virtual void Wombat::MamdaNewsHeadline::getNativeRelatedSymbols ( const char **&  symbols, mama_size_t &  numSymbols  ) const

virtual

Get an array of native feed symbol codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getIndustries()

virtual void Wombat::MamdaNewsHeadline::getIndustries ( const char **&  industries, mama_size_t &  numIndustries  ) const

virtual

Get an array of normalized industry codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getMarketSectors()

virtual void Wombat::MamdaNewsHeadline::getMarketSectors ( const char **&  marketSectors, mama_size_t &  numMarketSectors  ) const

virtual

Get an array of normalized market sector codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getRegions()

virtual void Wombat::MamdaNewsHeadline::getRegions ( const char **&  regions, mama_size_t &  numRegions  ) const

virtual

Get an array of normalized region codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getCountries()

virtual void Wombat::MamdaNewsHeadline::getCountries ( const char **&  countries, mama_size_t &  numCountries  ) const

virtual

Get an array of ISO country codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getProducts()

virtual void Wombat::MamdaNewsHeadline::getProducts ( const char **&  products, mama_size_t &  numProducts  ) const

virtual

Get an array of normalized product codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getTopics()

virtual void Wombat::MamdaNewsHeadline::getTopics ( const char **&  topics, mama_size_t &  numTopics  ) const

virtual

Get an array of normalized topic (or "subject") codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getMiscCodes()

virtual void Wombat::MamdaNewsHeadline::getMiscCodes ( const char **&  miscCodes, mama_size_t &  numMiscCodes  ) const

virtual

Get an array of normalized miscellaneous codes associated with this news story.

Miscellaneous codes are those not categorized as industry, market sector, region, country or product codes.

Implements Wombat::MamdaNewsMetaData.

getRelatedSymbols()

virtual void Wombat::MamdaNewsHeadline::getRelatedSymbols ( const char **&  symbols, mama_size_t &  numSymbols  ) const

virtual

Get an array of normalized symbol codes associated with this news story.

Implements Wombat::MamdaNewsMetaData.

getNewsPriority()

virtual MamdaNewsPriority Wombat::MamdaNewsHeadline::getNewsPriority ( ) const

virtual

Returns

Whether the feed provider has designated this story as with normal priority or "hot" (important) priority.

Implements Wombat::MamdaNewsMetaData.

getNewsStoryRevNumber()

virtual mama_u16_t Wombat::MamdaNewsHeadline::getNewsStoryRevNumber ( ) const

virtual

Returns

The revision number. Note: the value returned is zero if the data source does not provide revision numbers.

Implements Wombat::MamdaNewsMetaData.

getNewsOrigStoryTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getNewsOrigStoryTime ( ) const

virtual

Returns

The original publish time of the news story.

Implements Wombat::MamdaNewsMetaData.

getSymbol()

virtual const char* Wombat::MamdaNewsHeadline::getSymbol ( ) const

virtual

Get the instruments string symbol.

Returns

Symbol. This is the "well-known" symbol for the security, including any symbology mapping performed by the publisher.

Implements Wombat::MamdaBasicEvent.

getPartId()

virtual const char* Wombat::MamdaNewsHeadline::getPartId ( ) const

virtual

Get the participant identifier.

Returns

Participant ID. This may be an exchange identifier, a market maker ID, etc., or NULL (if this is not related to any specific participant).

Implements Wombat::MamdaBasicEvent.

getSrcTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getSrcTime ( ) const

virtual

Get the source time.

Returns

Source time. Typically, the exchange generated feed time stamp. This is often the same as the "event time", because many feeds do not distinguish between the actual event time and when the exchange sent the message.

Implements Wombat::MamdaBasicEvent.

getActivityTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getActivityTime ( ) const

virtual

Get the activity time.

Returns

Activity time. A feed handler generated time stamp representing when the data item was last updated.

Implements Wombat::MamdaBasicEvent.

getLineTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getLineTime ( ) const

virtual

Get the line time.

Returns

Line time. A feed handler (or similar publisher) time stamp representing the time that such publisher received the update message pertaining to the event. If clocks are properly synchronized and the source time (see above) is accurate enough, then the difference between the source time and line time is the latency between the data source and the feed handler.

Implements Wombat::MamdaBasicEvent.

getSendTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getSendTime ( ) const

virtual

Get the send time.

Returns

Send time. A feed handler (or similar publisher) time stamp representing the time that such publisher sent the current message. The difference between the line time and send time is the latency within the feed handler itself. Also, if clocks are properly synchronized then the difference between the send time and current time is the latency within the market data distribution framework (i.e. MAMA and the underlying middleware). See MAMA API: MamaDateTime::currentTime()).

Implements Wombat::MamdaBasicEvent.

getMsgQual()

virtual const MamaMsgQual& Wombat::MamdaNewsHeadline::getMsgQual ( ) const

virtual

Get the message qualifier.

Returns

Message Qualifier. The message qualifier provides information in relation to messages duplicate, delayed or out-of-sequence status.

Implements Wombat::MamdaBasicEvent.

getEventTime()

virtual const MamaDateTime& Wombat::MamdaNewsHeadline::getEventTime ( ) const

virtual

Get the event time.

Returns

Event time. Typically, when the event actually occurred. This is often the same as the "source time", because many feeds do not distinguish between the actual event time and when the exchange sent the message.

Implements Wombat::MamdaBasicEvent.

getEventSeqNum()

virtual mama_seqnum_t Wombat::MamdaNewsHeadline::getEventSeqNum ( ) const

virtual

Get the event sequence number.

Returns

Source sequence number. The exchange generated sequence number.

Implements Wombat::MamdaBasicEvent.

getSymbolFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getSymbolFieldState ( ) const

virtual

Get the string symbol field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getPartIdFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getPartIdFieldState ( ) const

virtual

Get the participant identifier field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getSrcTimeFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getSrcTimeFieldState ( ) const

virtual

Get the source time field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getActivityTimeFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getActivityTimeFieldState ( ) const

virtual

Get the activity time field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getLineTimeFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getLineTimeFieldState ( ) const

virtual

Get the line time of the update.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getSendTimeFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getSendTimeFieldState ( ) const

virtual

Get the send time field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getMsgQualFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getMsgQualFieldState ( ) const

virtual

Get the message qualifier field state.

Returns

Message Qualifier. The message qualifier provides information in relation to messages duplicate, delayed or out-of-sequence status.

Implements Wombat::MamdaBasicEvent.

getEventTimeFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getEventTimeFieldState ( ) const

virtual

Get the event time field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

getEventSeqNumFieldState()

MamdaFieldState Wombat::MamdaNewsHeadline::getEventSeqNumFieldState ( ) const

virtual

Get the event sequence number field state.

Returns

MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

setHeadlineText()

void Wombat::MamdaNewsHeadline::setHeadlineText

(

const char *

headlineText

)

setHeadlineId()

void Wombat::MamdaNewsHeadline::setHeadlineId

(

const char *

headlineId

)

setStoryId()

void Wombat::MamdaNewsHeadline::setStoryId

(

const char *

storyId

)

setHasStory()

void Wombat::MamdaNewsHeadline::setHasStory

(

bool

hasStory

)

setSourceId()

void Wombat::MamdaNewsHeadline::setSourceId

(

const char *

source

)

setOrigStoryId()

void Wombat::MamdaNewsHeadline::setOrigStoryId

(

const char *

storyId

)

setOrigSourceId()

void Wombat::MamdaNewsHeadline::setOrigSourceId

(

const char *

origSourceId

)

setLanguageId()

void Wombat::MamdaNewsHeadline::setLanguageId

(

const char *

langId

)

setNativeCodes()

void Wombat::MamdaNewsHeadline::setNativeCodes	(	const char **	codes,
		mama_size_t	numCodes
	)

setNativeRelatedSymbols()

void Wombat::MamdaNewsHeadline::setNativeRelatedSymbols	(	const char **	symbols,
		mama_size_t	numSymbols
	)

setIndustries()

void Wombat::MamdaNewsHeadline::setIndustries	(	const char **	industries,
		mama_size_t	numIndustries
	)

setMarketSectors()

void Wombat::MamdaNewsHeadline::setMarketSectors	(	const char **	marketSectors,
		mama_size_t	numMarketSectors
	)

setRegions()

void Wombat::MamdaNewsHeadline::setRegions	(	const char **	regions,
		mama_size_t	numRegions
	)

setCountries()

void Wombat::MamdaNewsHeadline::setCountries	(	const char **	countries,
		mama_size_t	numCountries
	)

setProducts()

void Wombat::MamdaNewsHeadline::setProducts	(	const char **	products,
		mama_size_t	numProducts
	)

setTopics()

void Wombat::MamdaNewsHeadline::setTopics	(	const char **	topics,
		mama_size_t	numTopics
	)

setMiscCodes()

void Wombat::MamdaNewsHeadline::setMiscCodes	(	const char **	codes,
		mama_size_t	numCodes
	)

setRelatedSymbols()

void Wombat::MamdaNewsHeadline::setRelatedSymbols	(	const char **	symbols,
		mama_size_t	numSymbols
	)

setPriority()

void Wombat::MamdaNewsHeadline::setPriority

(

MamdaNewsPriority

priority

)

setStoryRevNumber()

void Wombat::MamdaNewsHeadline::setStoryRevNumber

(

mama_u16_t

storyRevNum

)

setEventSeqNum()

void Wombat::MamdaNewsHeadline::setEventSeqNum

(

mama_seqnum_t

seqNum

)

setEventTime()

void Wombat::MamdaNewsHeadline::setEventTime

(

const MamaDateTime &

eventTime

)

setOrigStoryTime()

void Wombat::MamdaNewsHeadline::setOrigStoryTime

(

const MamaDateTime &

storyTime

)

setSrcTime()

void Wombat::MamdaNewsHeadline::setSrcTime

(

const MamaDateTime &

srcTime

)

setActivityTime()

void Wombat::MamdaNewsHeadline::setActivityTime

(

const MamaDateTime &

actTime

)

setLineTime()

void Wombat::MamdaNewsHeadline::setLineTime

(

const MamaDateTime &

lineTime

)

setSendTime()

void Wombat::MamdaNewsHeadline::setSendTime

(

const MamaDateTime &

sendTime

)

setMsgQual()

void Wombat::MamdaNewsHeadline::setMsgQual

(

const MamaMsgQual &

msgQualifier

)

clear()

void Wombat::MamdaNewsHeadline::clear

(

)

setSubscriptionInfo()

void Wombat::MamdaNewsHeadline::setSubscriptionInfo

(

MamdaSubscription *

subsc

)

Implementation: save the subscription info for the headline (so we know where to request stories from).

setSubscInfo()

void Wombat::MamdaNewsHeadline::setSubscInfo	(	MamaQueue *	queue,
		MamaSource *	source
	)

getQueue()

MamaQueue* Wombat::MamdaNewsHeadline::getQueue

(

)

const

Implementation: get the subscription info for the headline.

getSource()

MamaSource* Wombat::MamdaNewsHeadline::getSource

(

)

const

---

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

• MamdaNewsHeadline.h