MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.db.stream.IXCustomQuery Interface Reference

The custom query interface defines the functions implemented by each Custom Query object used to specifically query the tables of the underlying database. More...

Inheritance diagram for MyCaffe.db.stream.IXCustomQuery:
MyCaffe.db.stream.StandardQueryTextFile MyCaffe.db.stream.StandardQueryWAVFile

Public Member Functions

void Open ()
 Open a connection to the underlying database using the connection string specified. More...
 
void Close ()
 Close a currently open connection. More...
 
List< int > GetQuerySize ()
 Returns the query count for the current query. More...
 
double[] QueryByTime (DateTime dt, TimeSpan ts, int nCount)
 Query the fields specified (in the Open function) starting from the date-time specified. More...
 
byte[] QueryBytes ()
 Query the raw bytes. More...
 
List< double[]> QueryRealD ()
 Query the data as a set one or more double arrays. More...
 
List< float[]> QueryRealF ()
 Query the data as a set one or more float arrays. More...
 
Dictionary< string, float > QueryInfo ()
 The Query information returns information about the data queried such as header information. More...
 
IXCustomQuery Clone (string strParam)
 Return a new instance of the custom query. More...
 
void Reset ()
 Reset the custom query. More...
 
byte[] ConvertOutput (float[] rg, out string strType)
 Converts the output values into the native type used by the CustomQuery. More...
 

Properties

CUSTOM_QUERY_TYPE QueryType [get]
 Returns the custom query type supported by the custom query. More...
 
string Name [get]
 Returns the name of the Custom Query. More...
 
int FieldCount [get]
 Returns the field count for this query. More...
 

Detailed Description

The custom query interface defines the functions implemented by each Custom Query object used to specifically query the tables of the underlying database.

Each Custom Query implementation DLL must be placed within the

'./CustomQuery'

directory that is relative to the MyCaffe.db.stream.dll file location. For example, see the following directory structure:

c:/temp/MyCaffe.db.stream.dll
c:/temp/CustomQuery/mycustomquery.dll - implements the IXCustomQuery interface.
The MyCaffe.db.stream namespace contains all data streaming related classes.
The MyCaffe namespace contains the main body of MyCaffe code that closesly tracks the C++ Caffe open-...
Definition: Annotation.cs:12

Definition at line 167 of file Interfaces.cs.

Member Function Documentation

◆ Clone()

IXCustomQuery MyCaffe.db.stream.IXCustomQuery.Clone ( string  strParam)

Return a new instance of the custom query.

Parameters
strParamSpecifies the custom query parameters.
Returns
A new instance of the custom query is returned.

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ Close()

void MyCaffe.db.stream.IXCustomQuery.Close ( )

Close a currently open connection.

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ ConvertOutput()

byte[] MyCaffe.db.stream.IXCustomQuery.ConvertOutput ( float[]  rg,
out string  strType 
)

Converts the output values into the native type used by the CustomQuery.

Parameters
rgSpecifies the raw output data.
strTypeReturns the output type.
Returns
The converted output data is returned as a byte stream.

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ GetQuerySize()

List< int > MyCaffe.db.stream.IXCustomQuery.GetQuerySize ( )

Returns the query count for the current query.

Returns
The query size is returned..

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ Open()

void MyCaffe.db.stream.IXCustomQuery.Open ( )

Open a connection to the underlying database using the connection string specified.

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ QueryBytes()

byte[] MyCaffe.db.stream.IXCustomQuery.QueryBytes ( )

Query the raw bytes.

Returns

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ QueryByTime()

double[] MyCaffe.db.stream.IXCustomQuery.QueryByTime ( DateTime  dt,
TimeSpan  ts,
int  nCount 
)

Query the fields specified (in the Open function) starting from the date-time specified.

Items are returned in column-major format (e.g. datetime, val1, val2, datetime, val1, val2...)

Parameters
dtSpecifies the start date-time where the query should start. Note, using ID based querying assumes that all other Custom Queries used have synchronized date-time fields.
tsSpecifies the timespan between data items.
nCountSpecifies the number of items to query.
Returns
A two dimensional array is returned containing the items for each field queried.

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ QueryInfo()

Dictionary< string, float > MyCaffe.db.stream.IXCustomQuery.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.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ QueryRealD()

List< double[]> MyCaffe.db.stream.IXCustomQuery.QueryRealD ( )

Query the data as a set one or more double arrays.

Returns

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ QueryRealF()

List< float[]> MyCaffe.db.stream.IXCustomQuery.QueryRealF ( )

Query the data as a set one or more float arrays.

Returns

Implemented in MyCaffe.db.stream.StandardQueryTextFile, and MyCaffe.db.stream.StandardQueryWAVFile.

◆ Reset()

void MyCaffe.db.stream.IXCustomQuery.Reset ( )

Property Documentation

◆ FieldCount

int MyCaffe.db.stream.IXCustomQuery.FieldCount
get

Returns the field count for this query.

Definition at line 180 of file Interfaces.cs.

◆ Name

string MyCaffe.db.stream.IXCustomQuery.Name
get

Returns the name of the Custom Query.

Definition at line 176 of file Interfaces.cs.

◆ QueryType

CUSTOM_QUERY_TYPE MyCaffe.db.stream.IXCustomQuery.QueryType
get

Returns the custom query type supported by the custom query.

Definition at line 172 of file Interfaces.cs.


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