MyCaffe.db.stream.IXStreamDatabase Interface Reference

The IXStreamDatabase interface is the main interface to the MyCaffe Streaing Database. More...

Inheritance diagram for MyCaffe.db.stream.IXStreamDatabase:

Public Member Functions
void	Initialize (QUERY_TYPE qt, string strSchema)
	Initialize the streaming database by loading the initial queues. More...
void	Shutdown ()
	Shutdown the database. More...
void	Reset (int nStartOffset=0)
	Reset the query postion to the start established during Initialize. More...
SimpleDatum	Query (int nWait=1000)
	Query a setgment of data from the internal queueus. More...
int[]	QuerySize ()
	Returns the Query size using the Blob sizing methodology. More...
Dictionary< string, float >	QueryInfo ()
	The Query information returns information about the data queried such as header information. More...

Detailed Description

The IXStreamDatabase interface is the main interface to the MyCaffe Streaing Database.

Definition at line 51 of file Interfaces.cs.

Member Function Documentation

Initialize()

void MyCaffe.db.stream.IXStreamDatabase.Initialize	(	QUERY_TYPE	qt,
		string	strSchema
	)

Initialize the streaming database by loading the initial queues.

Parameters

qt	Specifies the query type to use (see remarks).
strSchema	Specifies the query schema to use.

Additional settings for each query type are specified in the 'strSchema' parameter as a set of key=value pairs for each of the settings. The following are the query specific settings that are expected for each QUERY_TYPE.

qt = TIME: 'QueryCount' - Specifies the number of items to include in each query. 'Start' - Specifies the start date of the stream. 'TimeSpanInMs' - Specifies the time increment between data items in the stream in milliseconds. 'SegmentSize' - Specifies the segment size of data queried from the database. 'MaxCount' - Specifies the maximum number of items to load into memory for each custom query.

qt = GENERAL: none at this time.

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

Query()

SimpleDatum MyCaffe.db.stream.IXStreamDatabase.Query

(

int

nWait = 1000

)

Query a setgment of data from the internal queueus.

Parameters

nWait

Optionally, specifies the amount of time to wait for data in ms. (default = 1000ms).

Returns

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

QueryInfo()

Dictionary< string, float > MyCaffe.db.stream.IXStreamDatabase.QueryInfo

(

)

The Query information returns information about the data queried such as header information.

Returns

The information about the data is returned.

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

QuerySize()

int[] MyCaffe.db.stream.IXStreamDatabase.QuerySize

(

)

Returns the Query size using the Blob sizing methodology.

Returns

The data size is returned.

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

Reset()

void MyCaffe.db.stream.IXStreamDatabase.Reset

(

int

nStartOffset = 0

)

Reset the query postion to the start established during Initialize.

Parameters

nStartOffset

Optionally, specifies an offset from the start to use (default = 0).

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

Shutdown()

void MyCaffe.db.stream.IXStreamDatabase.Shutdown

(

)

Shutdown the database.

Implemented in MyCaffe.db.stream.MyCaffeStreamDatabase.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.db.stream/Interfaces.cs