The value stream descriptor describes a single value stream within a value item. More...

Public Types
enum	STREAM_VALUE_TYPE { NUMERIC = 0x01 , CATEGORICAL = 0x02 }
	Defines the stream value type. More...

enum	STREAM_CLASS_TYPE { STATIC = 0x01 , OBSERVED = 0x02 , KNOWN = 0x04 }
	Defines the stream class type. More...

Public Member Functions
	ValueStreamDescriptor (int nID, string strName, int nOrdering, STREAM_CLASS_TYPE classType, STREAM_VALUE_TYPE valueType, DateTime? dtStart=null, DateTime? dtEnd=null, int? nSecPerStep=null, int nSteps=1)
	The constructor. More...

	ValueStreamDescriptor (ValueStreamDescriptor vsd)
	The constructor. More...

void	ToBytes (BinaryWriter bw)
	Returns the value stream descriptor as a byte array. More...

override string	ToString ()
	Returns the string rendering of the value stream descriptor. More...

Static Public Member Functions
static ValueStreamDescriptor	FromBytes (BinaryReader br)
	Returns a new ValueStreamDescriptor from a byte array. More...

Properties
int	ID `[get]`
	Returns the value stream ID. More...

string	Name `[get]`
	Return the value stream name. More...

int	Ordering `[get]`
	Returns the value stream ordering. More...

STREAM_CLASS_TYPE	ClassType `[get]`
	Returns the value stream class type. More...

STREAM_VALUE_TYPE	ValueType `[get]`
	Returns the value stream value type. More...

DateTime?	Start `[get]`
	Returns the value stream start time (null with STATIC class). More...

DateTime?	End `[get]`
	Returns the value stream end time (null with STATIC class). More...

int?	SecondsPerStep `[get]`
	Returns the value stream seconds per step (null with STATIC class). More...

int	Steps `[get]`
	Returns the number of items in the value stream. More...

Detailed Description

The value stream descriptor describes a single value stream within a value item.

Definition at line 384 of file TemporalDescriptor.cs.

Member Enumeration Documentation

◆ STREAM_CLASS_TYPE

enum MyCaffe.basecode.descriptors.ValueStreamDescriptor.STREAM_CLASS_TYPE

Defines the stream class type.

Enumerator
STATIC	Specifies static values that are not time related. The DateTime in each static value is set to NULL.
OBSERVED	Specifies raw values that are only known up to the present time.
KNOWN	Specifies raw values that are known in both the past and future.

Definition at line 414 of file TemporalDescriptor.cs.

◆ STREAM_VALUE_TYPE

enum MyCaffe.basecode.descriptors.ValueStreamDescriptor.STREAM_VALUE_TYPE

Defines the stream value type.

Enumerator
NUMERIC	Specifies that the value stream hold numeric data.
CATEGORICAL	Specifies that the value stream holds categorical data.

Definition at line 399 of file TemporalDescriptor.cs.

Constructor & Destructor Documentation

◆ ValueStreamDescriptor() [1/2]

MyCaffe.basecode.descriptors.ValueStreamDescriptor.ValueStreamDescriptor	(	int	nID,
		string	strName,
		int	nOrdering,
		STREAM_CLASS_TYPE	classType,
		STREAM_VALUE_TYPE	valueType,
		DateTime?	dtStart = `null`,
		DateTime?	dtEnd = `null`,
		int?	nSecPerStep = `null`,
		int	nSteps = `1`
	)

The constructor.

Parameters

nID	Specifies the value stream ID.
strName	Specifies the value stream name.
nOrdering	Specifies the value stream ordering.
classType	Specifies the value stream class type.
valueType	Specifies the value stream value type.
dtStart	Specifies the start time of the value stream.
dtEnd	Specifies the end time of the value stream.
nSecPerStep	Specifies the number of seconds in each step.
nSteps	Optionally, specifies the number of steps taken on each iteration (default = 1).

Definition at line 442 of file TemporalDescriptor.cs.

◆ ValueStreamDescriptor() [2/2]

MyCaffe.basecode.descriptors.ValueStreamDescriptor.ValueStreamDescriptor ( ValueStreamDescriptor vsd )

The constructor.

Parameters

vsd	Specifies the ValueStreamDescriptor to copy.

Definition at line 459 of file TemporalDescriptor.cs.

Member Function Documentation

◆ FromBytes()

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

static

Returns a new ValueStreamDescriptor from a byte array.

Parameters

br	Specifies the binary reader.

Returns: The value stream descriptor is returned.

Definition at line 477 of file TemporalDescriptor.cs.

◆ ToBytes()

void MyCaffe.basecode.descriptors.ValueStreamDescriptor.ToBytes ( BinaryWriter bw )

Returns the value stream descriptor as a byte array.

Returns: The byte array is returned.

Definition at line 509 of file TemporalDescriptor.cs.

◆ ToString()

override string MyCaffe.basecode.descriptors.ValueStreamDescriptor.ToString ( )

Returns the string rendering of the value stream descriptor.

Returns: The string representation is returned.

Definition at line 617 of file TemporalDescriptor.cs.

Property Documentation

◆ ClassType

STREAM_CLASS_TYPE MyCaffe.basecode.descriptors.ValueStreamDescriptor.ClassType

get

Returns the value stream class type.

Definition at line 563 of file TemporalDescriptor.cs.

◆ End

DateTime? MyCaffe.basecode.descriptors.ValueStreamDescriptor.End

get

Returns the value stream end time (null with STATIC class).

Definition at line 590 of file TemporalDescriptor.cs.

◆ ID

int MyCaffe.basecode.descriptors.ValueStreamDescriptor.ID

get

Returns the value stream ID.

Definition at line 536 of file TemporalDescriptor.cs.

◆ Name

string MyCaffe.basecode.descriptors.ValueStreamDescriptor.Name

get

Return the value stream name.

Definition at line 545 of file TemporalDescriptor.cs.

◆ Ordering

int MyCaffe.basecode.descriptors.ValueStreamDescriptor.Ordering

get

Returns the value stream ordering.

Definition at line 554 of file TemporalDescriptor.cs.

◆ SecondsPerStep

int? MyCaffe.basecode.descriptors.ValueStreamDescriptor.SecondsPerStep

get

Returns the value stream seconds per step (null with STATIC class).

Definition at line 599 of file TemporalDescriptor.cs.

◆ Start

DateTime? MyCaffe.basecode.descriptors.ValueStreamDescriptor.Start

get

Returns the value stream start time (null with STATIC class).

Definition at line 581 of file TemporalDescriptor.cs.

◆ Steps

int MyCaffe.basecode.descriptors.ValueStreamDescriptor.Steps

get

Returns the number of items in the value stream.

Definition at line 608 of file TemporalDescriptor.cs.

◆ ValueType

STREAM_VALUE_TYPE MyCaffe.basecode.descriptors.ValueStreamDescriptor.ValueType

get

Returns the value stream value type.

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

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ STREAM_CLASS_TYPE

◆ STREAM_VALUE_TYPE

Constructor & Destructor Documentation

◆ ValueStreamDescriptor() [1/2]

◆ ValueStreamDescriptor() [2/2]

Member Function Documentation

◆ FromBytes()

◆ ToBytes()

◆ ToString()

Property Documentation

◆ ClassType

◆ End

◆ ID

◆ Name

◆ Ordering

◆ SecondsPerStep

◆ Start

◆ Steps

◆ ValueType