The TemporalDescriptor is used to describe a temporal aspects of the data source. More...

Public Member Functions
	TemporalDescriptor ()
	The constructor. More...

	TemporalDescriptor (TemporalDescriptor td)
	The constructor. More...

byte[]	ToBytes ()
	Returns the temporal descriptor as a byte array. More...

Static Public Member Functions
static TemporalDescriptor	FromBytes (byte[] rgb)
	Returns a new TemporalDescriptor from a byte array. More...

Properties
List< ValueStreamDescriptor >	ValueStreamDescriptors `[getset]`
	Returns the value stream descriptor. More...

OrderedValueStreamDescriptorSet	OrderedValueStreamDescriptors `[get]`
	Retunrs the ordered set of stream descriptors. More...

List< ValueItemDescriptor >	ValueItemDescriptors `[getset]`
	Returns the value item descriptor. More...

ReadOnlyCollection< ValueItemDescriptor >	ValueItemDescriptorItems `[get]`
	Returns the value item descriptors as a read-only array. More...

int	TotalSteps `[get]`
	Returns the total number of temporal steps. More...

DateTime?	StartDate `[get]`
	Return the start date. More...

DateTime?	EndDate `[get]`
	Return the end date. More...

Detailed Description

The TemporalDescriptor is used to describe a temporal aspects of the data source.

Definition at line 20 of file TemporalDescriptor.cs.

Constructor & Destructor Documentation

◆ TemporalDescriptor() [1/2]

MyCaffe.basecode.descriptors.TemporalDescriptor.TemporalDescriptor ( )

The constructor.

Definition at line 28 of file TemporalDescriptor.cs.

◆ TemporalDescriptor() [2/2]

MyCaffe.basecode.descriptors.TemporalDescriptor.TemporalDescriptor ( TemporalDescriptor td )

The constructor.

Parameters

td	Specifies a TemporalDescriptor to copy.

Definition at line 36 of file TemporalDescriptor.cs.

Member Function Documentation

◆ FromBytes()

static TemporalDescriptor MyCaffe.basecode.descriptors.TemporalDescriptor.FromBytes ( byte[] rgb )

static

Returns a new TemporalDescriptor from a byte array.

Parameters

rgb	Specifies the byte array.

Returns: The temporal descriptor is returned, or null.

Definition at line 139 of file TemporalDescriptor.cs.

◆ ToBytes()

byte[] MyCaffe.basecode.descriptors.TemporalDescriptor.ToBytes ( )

Returns the temporal descriptor as a byte array.

Returns: The byte array is returned.

Definition at line 169 of file TemporalDescriptor.cs.

Property Documentation

◆ EndDate

DateTime? MyCaffe.basecode.descriptors.TemporalDescriptor.EndDate

get

Return the end date.

Definition at line 122 of file TemporalDescriptor.cs.

◆ OrderedValueStreamDescriptors

OrderedValueStreamDescriptorSet MyCaffe.basecode.descriptors.TemporalDescriptor.OrderedValueStreamDescriptors

get

Retunrs the ordered set of stream descriptors.

Definition at line 63 of file TemporalDescriptor.cs.

◆ StartDate

DateTime? MyCaffe.basecode.descriptors.TemporalDescriptor.StartDate

get

Return the start date.

Definition at line 107 of file TemporalDescriptor.cs.

◆ TotalSteps

int MyCaffe.basecode.descriptors.TemporalDescriptor.TotalSteps

get

Returns the total number of temporal steps.

Definition at line 89 of file TemporalDescriptor.cs.

◆ ValueItemDescriptorItems

ReadOnlyCollection<ValueItemDescriptor> MyCaffe.basecode.descriptors.TemporalDescriptor.ValueItemDescriptorItems

get

Returns the value item descriptors as a read-only array.

Definition at line 81 of file TemporalDescriptor.cs.

◆ ValueItemDescriptors

List<ValueItemDescriptor> MyCaffe.basecode.descriptors.TemporalDescriptor.ValueItemDescriptors

getset

Returns the value item descriptor.

Definition at line 72 of file TemporalDescriptor.cs.

◆ ValueStreamDescriptors

List<ValueStreamDescriptor> MyCaffe.basecode.descriptors.TemporalDescriptor.ValueStreamDescriptors