Embedded Python Real-Time FrameWork : API  Build 20250616.1
 All Classes Namespaces Files Functions Variables Pages
pyRT.native.warpModule.CurrentUpdate Class Reference

Access to native warp.getXxx() API to query the current update, with methods to use both the native API as well as the gatea.MktData.FieldList.FieldList class. More...

Public Member Functions

def __init__
 Constructor. More...
 
def GetField
 Get single field value. More...
 
def GetFieldList
 Get fields from native warp module and return FieldList. More...
 
def GetFields
 Get list of Field Values. More...
 
def GetRecordID
 Return unique record ID of current update. More...
 
def GetRecordName
 Return record name of current update. More...
 
def GetUpdateAsFieldList
 Get fields from native warp module and return FieldList. More...
 

Detailed Description

Access to native warp.getXxx() API to query the current update, with methods to use both the native API as well as the gatea.MktData.FieldList.FieldList class.

Member Description
_cxt warp module Context
See Also
gatea.MktData.FieldList.FieldList

Constructor & Destructor Documentation

def pyRT.native.warpModule.CurrentUpdate.__init__ (   self,
  cxt 
)

Constructor.

Parameters
cxt- Opaque Context from warp module

Member Function Documentation

def pyRT.native.warpModule.CurrentUpdate.GetField (   self,
  fid 
)

Get single field value.

Parameters
fid- Field ID
Returns
value
See Also
GetFields()
def pyRT.native.warpModule.CurrentUpdate.GetFieldList (   self,
  fids 
)

Get fields from native warp module and return FieldList.

Parameters
fids- List of Field ID's to query; None for all
Returns
Populated gatea.MktData.FieldList.FieldList
See Also
gatea.MktData.FieldList.FieldList
warp.getFields()
def pyRT.native.warpModule.CurrentUpdate.GetFields (   self,
  fids 
)

Get list of Field Values.

Parameters
fids- Field IDs to query [ fid1, fid2, fid3, ... ]
Returns
[ val1, val2, ... ]
See Also
GetFieldList()
def pyRT.native.warpModule.CurrentUpdate.GetRecordID (   self)

Return unique record ID of current update.

Returns
Unique record ID of current update
See Also
warp.getRecordID()
def pyRT.native.warpModule.CurrentUpdate.GetRecordName (   self)

Return record name of current update.

Returns
Record Name of current update
See Also
warp.getRecordName()
def pyRT.native.warpModule.CurrentUpdate.GetUpdateAsFieldList (   self)

Get fields from native warp module and return FieldList.

Returns
Populated gatea.MktData.FieldList.FieldList
See Also
gatea.MktData.FieldList.FieldList
warp.getUpdate()

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