pyRT.native.omniBridgeModule.Message Class Reference

Handy container for populating and accessing an omniBridge message into or out of the omniBridge module. More...

Inheritance diagram for pyRT.native.omniBridgeModule.Message:

Public Member Functions
def	__init__
	Constructor. More...
def	AddField
	Add field and value to FieldList. More...
def	AddFields
	Append a list or dict of fields to the FieldList. More...
def	Clear
	Reset field list. More...
def	Fields
	Return list of [ fid, val ] fields. More...
def	GetNative
	Returns native 3-element (optional 4-element) tuple. More...
def	HasField
	Return True if FieldList contains fid. More...
def	Rename
	Rename Ticker Name and Record ID. More...
def	Size
	Return Field List size. More...
def	UpdField
	Update existing field in FieldList, creating if necessary. More...

Detailed Description

Handy container for populating and accessing an omniBridge message into or out of the omniBridge module.

A native omniBridge message is a 3-element (4th is optional) tuple

Index	Type	Description
0	string	Ticker Name
1	int	(Optional) Unique Ticker ID
2	PyList	[ [ fid1, val1 ], [ fid2, val2 ], ... ]
3	long	(Optional) Message Time in Nanos since Epoch

Member	Description
_tkr	Ticker Name
_rid	Unique Record ID
_tm	(Optional) Timestamp in Nanos since Epoch
_fdb	[ [ fid1, val1 ], [ fid2, val2 ] ... ]
_idb	{ fid1 : val1, fid2 : val2, ... }
_bUpd	True if UpdField() has been called; False otherwise

Constructor & Destructor Documentation

def pyRT.native.omniBridgeModule.Message.__init__	(		self,
			tkr,
			rid = 0,
			tm = None
	)

Constructor.

Parameters

tkr	- Ticker Name
rid	- (Optional) Unique Record ID
tm	- (Optional) Timestamp in Nanos since Eopch

Member Function Documentation

def pyRT.native.omniBridgeModule.Message.AddField	(		self,
			fid,
			val
	)

Add field and value to FieldList.

Parameters

fid	- Field ID
val	- Field Value

def pyRT.native.omniBridgeModule.Message.AddFields	(		self,
			flds
	)

Append a list or dict of fields to the FieldList.

Type	Contents
list	[ [ fid1, val1 ], [ fid2, val2 ], ... ]
dict	{ fid1 : val1, fid2 : val2, ... }

Parameters

flds	- dict or list of fields to add

def pyRT.native.omniBridgeModule.Message.Clear

(

self

)

Reset field list.

def pyRT.native.omniBridgeModule.Message.Fields

(

self

)

Return list of [ fid, val ] fields.

Returns

[ [ fid1, val1 ], [ fid2, val2 ] ... ]

def pyRT.native.omniBridgeModule.Message.GetNative

(

self

)

Returns native 3-element (optional 4-element) tuple.

Returns

Native 3-element (optional 4-element) tuple

def pyRT.native.omniBridgeModule.Message.HasField	(		self,
			fid
	)

Return True if FieldList contains fid.

Returns

True if FieldList contains fid

def pyRT.native.omniBridgeModule.Message.Rename	(		self,
			rid,
			tkr
	)

Rename Ticker Name and Record ID.

Useful when publishing same Field List to multiple omniBridge streams

Parameters

rid	- Unique Record ID
tkr	- Ticker Name

Returns

self

def pyRT.native.omniBridgeModule.Message.Size

(

self

)

Return Field List size.

Returns

Field List Size

def pyRT.native.omniBridgeModule.Message.UpdField	(		self,
			fid,
			val
	)

Update existing field in FieldList, creating if necessary.

Parameters

fid	- Field ID
val	- New Field Value

See Also

AddField()

---

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

• native/omniBridgeModule.py