Security Class Reference

Public Types
typedef UInt64	UserData

Public Member Functions
SecurityId	id () const
StrRef	symbol () const
void	symbol (const StrRef &symbol)
StrRef	group () const
void	group (const StrRef &group)
StrRef	asset () const
void	asset (const StrRef &asset)
UInt32	seqNumber () const
UserData	userData () const

Protected Member Functions
	Security (SecurityId id)
	~Security ()
void	seqNumber (UInt32 seqNumber)
void	userData (UserData data)

Detailed Description

Definition at line 29 of file Security.h.

Member Typedef Documentation

UserData

typedef UInt64 UserData

User-defined data to be attached.

Definition at line 90 of file Security.h.

Constructor & Destructor Documentation

Security()

Security ( SecurityId id )

inlineprotected

Initializes instance.

Definition at line 100 of file Security.h.

~Security()

~Security ( )

inlineprotected

Cleans everything up.

Definition at line 108 of file Security.h.

Member Function Documentation

asset() [1/2]

StrRef asset ( ) const

inline

String field that indicates the underlying asset code (Product Code).

Definition at line 72 of file Security.h.

asset() [2/2]

void asset ( const StrRef & asset )

inline

Updates asset code.

Definition at line 78 of file Security.h.

group() [1/2]

StrRef group ( ) const

inline

Security group code.

An exchange specific code assigned to a group of related securities, which are concurrently affected by market events.

Definition at line 59 of file Security.h.

group() [2/2]

void group ( const StrRef & group )

inline

Assigns security group code.

Definition at line 65 of file Security.h.

id()

SecurityId id ( ) const

inline

Unique security identifier.

Security ID value will not be reused until the next trade date following an security expiration or deletion.

Definition at line 37 of file Security.h.

seqNumber() [1/2]

UInt32 seqNumber ( ) const

inline

Security-level sequence number.

Definition at line 84 of file Security.h.

seqNumber() [2/2]

void seqNumber ( UInt32 seqNumber )

inlineprotected

Updates sequence number.

Definition at line 111 of file Security.h.

symbol() [1/2]

StrRef symbol ( ) const

inline

Security name or symbol.

Definition at line 43 of file Security.h.

symbol() [2/2]

void symbol ( const StrRef & symbol )

inline

Updates security name or symbol.

Definition at line 49 of file Security.h.

userData() [1/2]

UserData userData ( ) const

inline

User-defined data.

Definition at line 93 of file Security.h.

userData() [2/2]

void userData ( UserData data )

inlineprotected

Sets user-defined data.

Definition at line 117 of file Security.h.