Method LTPDANamedItem/retrieve


  RETRIEVE retrieves LTPDA objects from an LTPDA repository with help of a LTPDANamedItem object.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: RETRIEVE retrieves LTPDA objects from an LTPDA repository
               with help of a LTPDANamedItem object. The method uses the
               name of the LTPDANamedItem object and a given timespan for
               querying the database.
               The name of the LTPDANamedItem object can contain a MySQL
               wildcard [%] or it can be a UUID.
 
  CALL:    objs = retrieve(namedItem, pl)
 
  INPUTS:
           namedItem  - LTPDANamedItem object(s)
           pl         - Configuration PLIST
 
  OUTPUTS:
           objs       - the retrieved object(s)
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class LTPDANamedItem
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
retrieve
HOSTNAME '' none Database server hostname.
DATABASE '' none Database name.
USERNAME '' none User name to use when connecting to the database. Leave blank to be prompted.
PASSWORD {} [0x0] none Password to use when connecting to the database. Leave blank to be prompted.
CONN [] none Java mysql object.
ID, IDS [] none A vector of object IDs.
CID [] none A vector of collection IDs.
UUID, UUIDS {} [0x0] none A cell array of UUIDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
TIMESPAN, TIME SPAN [] none

Example

plist('HOSTNAME', '', 'DATABASE', '', 'USERNAME', '', 'PASSWORD', cell(0,0), 'CONN', [[]], 'ID', [[]], 'CID', [[]], 'UUID', cell(0,0), 'BINARY', [true], 'TIMESPAN', [[]])

back to top back to top

Some information of the method LTPDANamedItem/retrieve are listed below:
Class name LTPDANamedItem
Method name retrieve
Category Signal Processing
Package name ltpda
Can be used as modifier 1
Supported numeric types {'double'}




©LTP Team