MyCaffe.layers.tft.LookupItem Class Reference

The lookup item manages a single lookup item used to map a name to an ID. More...

Public Member Functions
	LookupItem (string strName, int nIndex)
	The constructor. More...
	LookupItem (string strName, int nIndex, int nValidRangeStart, int nValidRangeEnd)
	The constructor. More...
bool	Compare (LookupItem item)
	Compare two LookupItems and return whether or not they are the same. More...
override string	ToString ()
	Returns a string representation of the lookup item. More...

Static Public Member Functions
static LookupItem	Load (XmlNode node)
	Load a LookupItem from an XML node. More...

Properties
string	Name [get]
	Specifies the lookup name. More...
int	ID [get]
	Specifies the lookup ID. More...
int	ValidRangeStartIndex [get]
	Returns the valid data range start index or -1 to ignore. More...
int	ValidRangeEndIndex [get]
	Returns the valid data range end index or -1 to ignore. More...
int?	ValidRangeCount [get]
	Returns the number of valid data items in the range or -1 if the range is not set. More...

Detailed Description

The lookup item manages a single lookup item used to map a name to an ID.

Definition at line 566 of file DataSchema.cs.

Constructor & Destructor Documentation

LookupItem() [1/2]

MyCaffe.layers.tft.LookupItem.LookupItem	(	string	strName,
		int	nIndex
	)

The constructor.

Parameters

strName	Specifies the lookup name.
nIndex	Specifies the lookup ID.

Definition at line 578 of file DataSchema.cs.

LookupItem() [2/2]

MyCaffe.layers.tft.LookupItem.LookupItem	(	string	strName,
		int	nIndex,
		int	nValidRangeStart,
		int	nValidRangeEnd
	)

The constructor.

Parameters

strName	Specifies the lookup name.
nIndex	Specifies the lookup ID.
nValidRangeStart	Specifies the valid data range start index (or -1 to ignore).
nValidRangeEnd	Specifies the valid data range end index (or -1 to ignore).

Definition at line 591 of file DataSchema.cs.

Member Function Documentation

Compare()

bool MyCaffe.layers.tft.LookupItem.Compare

(

LookupItem

item

)

Compare two LookupItems and return whether or not they are the same.

Parameters

item	Specifies the other LookupItem to compare.

Returns

Returns true if the two items are the same.

Definition at line 625 of file DataSchema.cs.

Load()

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

static

Load a LookupItem from an XML node.

Parameters

node	Specifies the XML node containing the lookup item.

Returns

The new lookup item is returned.

Definition at line 604 of file DataSchema.cs.

ToString()

override string MyCaffe.layers.tft.LookupItem.ToString

(

)

Returns a string representation of the lookup item.

Returns

The string representation is returned.

Definition at line 683 of file DataSchema.cs.

Property Documentation

ID

int MyCaffe.layers.tft.LookupItem.ID

get

Specifies the lookup ID.

Definition at line 650 of file DataSchema.cs.

Name

string MyCaffe.layers.tft.LookupItem.Name

get

Specifies the lookup name.

Definition at line 642 of file DataSchema.cs.

ValidRangeCount

int? MyCaffe.layers.tft.LookupItem.ValidRangeCount

get

Returns the number of valid data items in the range or -1 if the range is not set.

Definition at line 674 of file DataSchema.cs.

ValidRangeEndIndex

int MyCaffe.layers.tft.LookupItem.ValidRangeEndIndex

get

Returns the valid data range end index or -1 to ignore.

Definition at line 666 of file DataSchema.cs.

ValidRangeStartIndex

int MyCaffe.layers.tft.LookupItem.ValidRangeStartIndex

get

Returns the valid data range start index or -1 to ignore.

Definition at line 658 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