The StandardQueryTextFile provides queries that read text (*.txt) files residing in a given directory. More...

Inheritance diagram for MyCaffe.db.stream.StandardQueryTextFile:

Public Member Functions
	StandardQueryTextFile (string strParam=null)
	The constructor. More...

IXCustomQuery	Clone (string strParam)
	Clone the custom query returning a new copy. More...

void	Close ()
	Close the custom query. More...

void	Open ()
	Open the custom query. The query must be opened before calling QueryBytes. More...

double[]	QueryByTime (DateTime dt, TimeSpan ts, int nCount)
	The QueryByTime method is not implemented for this custom query. More...

byte[]	QueryBytes ()
	The QueryBytes method returns the bytes of the next file in the directory. More...

List< double[]>	QueryRealD ()
	The QueryRealD method is not implemented for this custom query. More...

List< float[]>	QueryRealF ()
	The QueryRealF method is not implemented for this custom query. More...

Dictionary< string, float >	QueryInfo ()
	The Query information returns information about the data queried such as header information. More...

List< int >	GetQuerySize ()
	The GetQuerySize method returns the size of the query as {1,1,filesize}. More...

void	Reset ()
	Reset the file index to the first file. 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 QUERY_TYPE of BYTE. More...

string	Name `[get]`
	Returns the custom query name 'StdTextFileQuery'. More...

int	FieldCount `[get]`
	Returns the field count of 1. More...

Properties inherited from MyCaffe.db.stream.IXCustomQuery
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 StandardQueryTextFile provides queries that read text (*.txt) files residing in a given directory.

Definition at line 14 of file StandardQueryTextFile.cs.

Constructor & Destructor Documentation

◆ StandardQueryTextFile()

MyCaffe.db.stream.StandardQueryTextFile.StandardQueryTextFile ( string strParam = null )

The constructor.

Parameters

strParam Specifies the parameters which shold contains the 'FilePath'=path key=value pair.

Definition at line 24 of file StandardQueryTextFile.cs.

Member Function Documentation

◆ Clone()

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

Clone the custom query returning a new copy.

Parameters

strParam Optionally, initialize the new copy with these parameters.

Returns: The new copy is returned.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 63 of file StandardQueryTextFile.cs.

◆ Close()

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

Close the custom query.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 71 of file StandardQueryTextFile.cs.

◆ ConvertOutput()

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

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

Parameters

rg	Specifies the raw output data.
strType	Returns the output type.

Returns: The converted output data is returned as a byte stream.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 190 of file StandardQueryTextFile.cs.

◆ GetQuerySize()

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

The GetQuerySize method returns the size of the query as {1,1,filesize}.

Returns: The query size is returned.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 160 of file StandardQueryTextFile.cs.

◆ Open()

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

Open the custom query. The query must be opened before calling QueryBytes.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 80 of file StandardQueryTextFile.cs.

◆ QueryBytes()

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

The QueryBytes method returns the bytes of the next file in the directory.

Returns: All bytes of the file are returned.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 117 of file StandardQueryTextFile.cs.

◆ QueryByTime()

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

The QueryByTime method is not implemented for this custom query.

Parameters

dt	not used.
ts	non used.
nCount	not used.

Returns: not used.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 108 of file StandardQueryTextFile.cs.

◆ QueryInfo()

Dictionary< string, float > MyCaffe.db.stream.StandardQueryTextFile.QueryInfo ( )

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

Returns: The information about the data is returned.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 151 of file StandardQueryTextFile.cs.

◆ QueryRealD()

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

The QueryRealD method is not implemented for this custom query.

Returns: not used.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 133 of file StandardQueryTextFile.cs.

◆ QueryRealF()

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

The QueryRealF method is not implemented for this custom query.

Returns: not used.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 142 of file StandardQueryTextFile.cs.

◆ Reset()

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

Reset the file index to the first file.

Implements MyCaffe.db.stream.IXCustomQuery.

Definition at line 179 of file StandardQueryTextFile.cs.

Property Documentation

◆ FieldCount

int MyCaffe.db.stream.StandardQueryTextFile.FieldCount

get

Returns the field count of 1.

Definition at line 53 of file StandardQueryTextFile.cs.

◆ Name

string MyCaffe.db.stream.StandardQueryTextFile.Name

get

Returns the custom query name 'StdTextFileQuery'.

Definition at line 45 of file StandardQueryTextFile.cs.

◆ QueryType

CUSTOM_QUERY_TYPE MyCaffe.db.stream.StandardQueryTextFile.QueryType

get

Returns the QUERY_TYPE of BYTE.

Definition at line 37 of file StandardQueryTextFile.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.db.stream/stdqueries/StandardQueryTextFile.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ StandardQueryTextFile()

Member Function Documentation

◆ Clone()

◆ Close()

◆ ConvertOutput()

◆ GetQuerySize()

◆ Open()

◆ QueryBytes()

◆ QueryByTime()

◆ QueryInfo()

◆ QueryRealD()

◆ QueryRealF()

◆ Reset()

Property Documentation

◆ FieldCount

◆ Name

◆ QueryType