MyCaffe.basecode.descriptors.ValueItemDescriptor Class Reference

The ValueItemDescriptor describes each value item (e.g., customer, station or stock) More...

Public Member Functions
	ValueItemDescriptor (int nID, string strName, DateTime? dtStart, DateTime? dtEnd, int? nSteps)
	The constructor. More...
	ValueItemDescriptor (ValueItemDescriptor vid)
	The copy constructor. More...
void	ToBytes (BinaryWriter bw)
	Returns the value item descriptor as a byte array. More...
override string	ToString ()
	Returns a string representation of the value item descriptor. More...

Static Public Member Functions
static ValueItemDescriptor	FromBytes (BinaryReader br)
	Returns a new ValueItemDescriptor from a binary reader. More...

Properties
int	ID [get]
	Returns the value item ID. More...
string	Name [get]
	Returns the value item name. More...
DateTime?	Start [get]
	Returns the start time (if any). More...
DateTime?	End [get]
	Returns the end time (if any). More...
int?	Steps [get]
	Returns the steps (if any). More...

Detailed Description

The ValueItemDescriptor describes each value item (e.g., customer, station or stock)

Definition at line 239 of file TemporalDescriptor.cs.

Constructor & Destructor Documentation

ValueItemDescriptor() [1/2]

MyCaffe.basecode.descriptors.ValueItemDescriptor.ValueItemDescriptor	(	int	nID,
		string	strName,
		DateTime?	dtStart,
		DateTime?	dtEnd,
		int?	nSteps
	)

The constructor.

Parameters

nID	Specifies the value item ID.
strName	Specifies the value item name.
dtStart	Optionally, specifies the start time of the item data.
dtEnd	Optionally, specifies the end time of the item data.
nSteps	Optionally, specifies teh steps in the item data.

Definition at line 255 of file TemporalDescriptor.cs.

ValueItemDescriptor() [2/2]

MyCaffe.basecode.descriptors.ValueItemDescriptor.ValueItemDescriptor

(

ValueItemDescriptor

vid

)

The copy constructor.

Parameters

vid	Specifies the value item descriptor to copy.

Definition at line 268 of file TemporalDescriptor.cs.

Member Function Documentation

FromBytes()

static ValueItemDescriptor MyCaffe.basecode.descriptors.ValueItemDescriptor.FromBytes ( BinaryReader  br )

static

Returns a new ValueItemDescriptor from a binary reader.

Parameters

br	Specifies the binary reader.

Returns

The value item descriptor is returned, or null.

Definition at line 282 of file TemporalDescriptor.cs.

ToBytes()

void MyCaffe.basecode.descriptors.ValueItemDescriptor.ToBytes

(

BinaryWriter

bw

)

Returns the value item descriptor as a byte array.

Parameters

bw	Specifies the binary writer.

Returns

The byte array is returned.

Definition at line 306 of file TemporalDescriptor.cs.

ToString()

override string MyCaffe.basecode.descriptors.ValueItemDescriptor.ToString

(

)

Returns a string representation of the value item descriptor.

Returns

The string representation is returned.

Definition at line 373 of file TemporalDescriptor.cs.

Property Documentation

End

DateTime? MyCaffe.basecode.descriptors.ValueItemDescriptor.End

get

Returns the end time (if any).

Definition at line 355 of file TemporalDescriptor.cs.

ID

int MyCaffe.basecode.descriptors.ValueItemDescriptor.ID

get

Returns the value item ID.

Definition at line 328 of file TemporalDescriptor.cs.

Name

string MyCaffe.basecode.descriptors.ValueItemDescriptor.Name

get

Returns the value item name.

Definition at line 337 of file TemporalDescriptor.cs.

Start

DateTime? MyCaffe.basecode.descriptors.ValueItemDescriptor.Start

get

Returns the start time (if any).

Definition at line 346 of file TemporalDescriptor.cs.

Steps

int? MyCaffe.basecode.descriptors.ValueItemDescriptor.Steps

get

Returns the steps (if any).

Definition at line 364 of file TemporalDescriptor.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.basecode/descriptors/TemporalDescriptor.cs