DSTimeSeriesDate Class

DSWS API (.NET)

[This is preliminary documentation and is subject to change.]

Defines the timeseries date

Inheritance Hierarchy

System Object
Datastream.DswsApi DSDateBase
Datastream.DswsApi DSTimeSeriesDate

Namespace: Datastream.DswsApi
Assembly: Datastream.DswsApi.NET4.0 (in Datastream.DswsApi.NET4.0.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

public sealed class DSTimeSeriesDate : DSDateBase

public sealed class DSTimeSeriesDate : DSDateBase

Public NotInheritable Class DSTimeSeriesDate _
	Inherits DSDateBase

Public NotInheritable Class DSTimeSeriesDate _
	Inherits DSDateBase

Remarks

A timeseries date used in a DSDataRequest specifies the time series information for which the data must be retrieved. The information is specified through Start, End and Frequency. The start/end date can be specified in absolute, relative or as string literal. You can use Absolute(DateTime) to construct an absolute date, Relative(Int32) to construct a relative date, or DSDateLiterals for specifying reserved date literals.

Examples

Following example shows the different types of date that can be created

C++

Copy to Clipboard Print

// Start/End specified as absolute dates 
var date1 = new DSTimeSeriesDate(DSDateType.Absolute(DateTime.Now.AddDays(-20)), DSDateType.Absolute(DateTime.Now), DSDateFrequency.Daily);

// Start/End specified as relative dates 
var date2 = new DSTimeSeriesDate(DSDateType.Relative(-20), DSDateType.Relative(0), DSDateFrequency.Daily);

// Start/End specified as literals 
var date3 = new DSTimeSeriesDate(DSDateType.Literal(DSDateLiterals.StartDateOfQuarter), DSDateType.Absolute(DateTime.Now), DSDateFrequency.Weekly);

// Dont specify date 
var date4 = new DSTimeSeriesDate(null, null, DSDateFrequency.None);

// Start/End specified as absolute dates 
var date1 = new DSTimeSeriesDate(DSDateType.Absolute(DateTime.Now.AddDays(-20)), DSDateType.Absolute(DateTime.Now), DSDateFrequency.Daily);

// Start/End specified as relative dates 
var date2 = new DSTimeSeriesDate(DSDateType.Relative(-20), DSDateType.Relative(0), DSDateFrequency.Daily);

// Start/End specified as literals 
var date3 = new DSTimeSeriesDate(DSDateType.Literal(DSDateLiterals.StartDateOfQuarter), DSDateType.Absolute(DateTime.Now), DSDateFrequency.Weekly);

// Dont specify date 
var date4 = new DSTimeSeriesDate(null, null, DSDateFrequency.None);

Version Information

.NET API Framework

Supported in: 4.1, 3.6