MyCaffe.db.temporal.ItemSet Class Reference

The ItemSet manages the data for a single item (e.g., customer, station, stock symbol, etc.) and its associated streams. More...

Public Member Functions
	ItemSet (CryptoRandom random, DatabaseTemporal db, ValueItem item, OrderedValueStreamDescriptorSet rgStrm)
	The constructor. More...
void	CleanUp ()
	Release all resources used. More...
void	Reset ()
	Reset the value index. More...
Tuple< DateTime, DateTime >	Load (out bool bEOD)
	Loads the data for the item starting at the specified date/time and loading the specified number of steps. More...
void	LoadLimit (int nMax)
	Clips the data to the load limit by removing older data items. More...
SimpleTemporalDatumCollection	GetData (int nQueryIdx, ref int? nValueIdx, DB_ITEM_SELECTION_METHOD valueSelectionMethod, int nHistSteps, int nFutSteps, int nValueStepOffset=1, bool bEnableDebug=false, string strDebugPath=null)
	Retreives the static, historical and future data at a selected step. More...
int	GetCount (int nSteps)
	Return the total number of queries available in the item set. More...

Properties
ValueItem	Item [get]
	Returns the value item. More...
OrderedValueStreamDescriptorSet	Streams [get]
	Returns the value streams. More...

Detailed Description

The ItemSet manages the data for a single item (e.g., customer, station, stock symbol, etc.) and its associated streams.

Definition at line 20 of file ItemSet.cs.

Constructor & Destructor Documentation

ItemSet()

MyCaffe.db.temporal.ItemSet.ItemSet	(	CryptoRandom	random,
		DatabaseTemporal	db,
		ValueItem	item,
		OrderedValueStreamDescriptorSet	rgStrm
	)

The constructor.

Parameters

random	Specifies the random number generator.
db	Specifies the database connection.
item	Specifies the value item.
rgStrm	Specifies the value streams associated with the item set.

Definition at line 41 of file ItemSet.cs.

Member Function Documentation

CleanUp()

void MyCaffe.db.temporal.ItemSet.CleanUp

(

)

Release all resources used.

Definition at line 52 of file ItemSet.cs.

GetCount()

int MyCaffe.db.temporal.ItemSet.GetCount

(

int

nSteps

)

Return the total number of queries available in the item set.

Parameters

nSteps

Specifies the number of steps in the query.

Returns

The number of queries available is returned.

Definition at line 627 of file ItemSet.cs.

GetData()

SimpleTemporalDatumCollection MyCaffe.db.temporal.ItemSet.GetData	(	int	nQueryIdx,
		ref int?	nValueIdx,
		DB_ITEM_SELECTION_METHOD	valueSelectionMethod,
		int	nHistSteps,
		int	nFutSteps,
		int	nValueStepOffset = 1,
		bool	bEnableDebug = false,
		string	strDebugPath = null
	)

Retreives the static, historical and future data at a selected step.

Parameters

nQueryIdx	Specifies the index of the query, used to show where this query is within a batch.
nValueIdx	Specifies the value index override when not null, returns the index used with in the item.
valueSelectionMethod	Specifies the value step selection method.
nHistSteps	Specifies the number of historical steps.
nFutSteps	Specifies the number of future steps.
nValueStepOffset	Specifes the step offset to apply when advancing the step index.
bEnableDebug	Optionally, specifies to enable debug output (default = false).
strDebugPath	Optionally, specifies the debug path where debug images are placed when 'EnableDebug' = true.

Returns

An collection of SimpleTemporalDatum is returned where: [0] = static num, [1] = static cat, [2] = historical num, [3] = historical cat, [4] = future num, [5] = future cat, [6] = target, and [7] = target history for a given item at the temporal selection point.

Note, the ordering for historical value streams is: observed, then known. Future value streams only contiain known value streams. If a dataset does not have one of the data types noted above, null is returned in the array slot (for example, if the dataset does not produce static numeric values, the array slot is set to [0] = null.

Definition at line 124 of file ItemSet.cs.

Load()

Tuple< DateTime, DateTime > MyCaffe.db.temporal.ItemSet.Load

(

out bool

bEOD

)

Loads the data for the item starting at the specified date/time and loading the specified number of steps.

Parameters

bEOD	Returns whether the end of data is found.

Returns

The end date is returned.

Exceptions

Exception

An exception is thrown on error.

Definition at line 87 of file ItemSet.cs.

LoadLimit()

void MyCaffe.db.temporal.ItemSet.LoadLimit

(

int

nMax

)

Clips the data to the load limit by removing older data items.

Parameters

nMax	Specifies the maximum number of steps to hold in memory.

Definition at line 104 of file ItemSet.cs.

Reset()

void MyCaffe.db.temporal.ItemSet.Reset

(

)

Reset the value index.

Definition at line 60 of file ItemSet.cs.

Property Documentation

Item

ValueItem MyCaffe.db.temporal.ItemSet.Item

get

Returns the value item.

Definition at line 68 of file ItemSet.cs.

Streams

OrderedValueStreamDescriptorSet MyCaffe.db.temporal.ItemSet.Streams

get

Returns the value streams.

Definition at line 76 of file ItemSet.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.db.temporal/ItemSet.cs