PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue > Interface Template Reference

The event in a time series. More...

Public Member Functions
IEvent< TNewValue >	WithValue< TNewValue > (TNewValue value)
	Copies this event with a different value. More...

Properties
TValue	Value [get]
	Gets the value associated with the event. More...
IEventMetadata	OriginalMetadata [get]
	Gets the IEventMetadata of the original event if the current event is an edit event. Otherwise it will be the same as Metadata. More...
IEventMetadata	Metadata [get]
	Gets the IEventMetadata of the current event. More...
bool	IsEditEvent [get]
	Gets true if the current event is an edit event. Otherwise false. More...

Detailed Description

The event in a time series.

Added in version 6.1.

Template Parameters

TValue

The event value type.

Member Function Documentation

IEvent<TNewValue> PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue >.WithValue< TNewValue >

(

TNewValue

value

)

Copies this event with a different value.

This method is useful when further transformation of the received value is needed, but the application wishes to preserve other event attributes. For example, if a IBytes value is received which the session wishes to interpret as Data.JSON.IJSON.

All attributes other than the value will be copied from the current event.

Template Parameters

TNewValue

The new value type.

Parameters

value

The new value.

Returns

A copy of the current event with the new value .

Property Documentation

bool PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue >.IsEditEvent

get

Gets true if the current event is an edit event. Otherwise false.

Returns

true if the current event is an edit event. false if the current event is an original event.

IEventMetadata PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue >.Metadata

get

Gets the IEventMetadata of the current event.

Returns

The IEventMetadata of the current event.

IEventMetadata PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue >.OriginalMetadata

get

Gets the IEventMetadata of the original event if the current event is an edit event. Otherwise it will be the same as Metadata.

The result is always the metadata of an original event, never that of an edit event.

Returns

The IEventMetadata of the original event or same as Metadata.

TValue PushTechnology.ClientInterface.Client.Features.TimeSeries.IEvent< TValue >.Value

get

Gets the value associated with the event.

Returns

The event value.

---

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

• Client.Public/Features/TimeSeries/ITimeSeries.cs