MyCaffe.layers.tft.Field Class Reference

The Field class manages a single field. More...

Public Types
enum	DATA_TYPE { REAL , CATEGORICAL }
	Defines the Data Type of the field. More...
enum	INPUT_TYPE {   NONE = 0x0000 , TIME = 0x0001 , ID = 0x0002 , KNOWN = 0x0004 ,   OBSERVED = 0x0008 , STATIC = 0x0010 , TARGET = 0x1000 }
	Defines the input type of the field. More...

Public Member Functions
	Field (string strName, int nIdx, DATA_TYPE dataType, INPUT_TYPE inputType)
	The constructor. More...
	Field (ValueStreamDescriptor vsd)
	Create a new field from the ValueStreamDescriptor specified. More...
override string	ToString ()
	Returns a string representation of the field. More...

Static Public Member Functions
static Field	Load (XmlNode node)
	Loads a new field from an XML node. More...

Properties
string	Name [get]
	Returns the name of the field. More...
int	Index [get]
	Returns the Index of the field within the numpy file. More...
DATA_TYPE	DataType [get]
	Returns the data type of the field. More...
INPUT_TYPE	InputType [get]
	Returns the input type of the field. More...

Detailed Description

The Field class manages a single field.

Definition at line 819 of file DataSchema.cs.

Member Enumeration Documentation

DATA_TYPE

enum MyCaffe.layers.tft.Field.DATA_TYPE

Defines the Data Type of the field.

Enumerator
REAL	Specifies the field contains a real value.
CATEGORICAL	Specifies the field contains a categorical value.

Definition at line 829 of file DataSchema.cs.

INPUT_TYPE

enum MyCaffe.layers.tft.Field.INPUT_TYPE

Defines the input type of the field.

Enumerator
NONE	Specifies an empty input type.
TIME	Specifies a time input type used for reference.
ID	Specifies an ID input type used for reference.
KNOWN	Specifies a known input type used in historical and future data.
OBSERVED	Specifies an observed input type used in historical data.
STATIC	Specifies a static input type used in static data.
TARGET	Specifies a target input type used in future data. Note an OBSERVED type can be OBSERVED and TARGET.

Definition at line 844 of file DataSchema.cs.

Constructor & Destructor Documentation

Field() [1/2]

MyCaffe.layers.tft.Field.Field	(	string	strName,
		int	nIdx,
		DATA_TYPE	dataType,
		INPUT_TYPE	inputType
	)

The constructor.

Parameters

strName	Specifies the field name.
nIdx	Specifies the index of the field within the NPY file.
dataType	Specifies the field data type.
inputType	Specifies the field input type.

Definition at line 883 of file DataSchema.cs.

Field() [2/2]

MyCaffe.layers.tft.Field.Field

(

ValueStreamDescriptor

vsd

)

Create a new field from the ValueStreamDescriptor specified.

Parameters

vsd	Specifies the ValueStreamDescriptor used to create the field.

Definition at line 895 of file DataSchema.cs.

Member Function Documentation

Load()

static Field MyCaffe.layers.tft.Field.Load ( XmlNode  node )

static

Loads a new field from an XML node.

Parameters

node	Specifies the XML node containing the field.

Returns

<The new Field is returned./returns>

Definition at line 922 of file DataSchema.cs.

ToString()

override string MyCaffe.layers.tft.Field.ToString

(

)

Returns a string representation of the field.

Returns

The string representation is returned.

Definition at line 992 of file DataSchema.cs.

Property Documentation

DataType

DATA_TYPE MyCaffe.layers.tft.Field.DataType

get

Returns the data type of the field.

Definition at line 975 of file DataSchema.cs.

Index

int MyCaffe.layers.tft.Field.Index

get

Returns the Index of the field within the numpy file.

Definition at line 967 of file DataSchema.cs.

InputType

INPUT_TYPE MyCaffe.layers.tft.Field.InputType

get

Returns the input type of the field.

Definition at line 983 of file DataSchema.cs.

Name

string MyCaffe.layers.tft.Field.Name

get

Returns the name of the field.

Definition at line 959 of file DataSchema.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.layers.tft/layers.tft/DataSchema.cs