PTDiffusionTimeSeriesEvent Class Reference

An event in a time series. More...

#include <PTDiffusionTimeSeriesEvent.h>

Inheritance diagram for PTDiffusionTimeSeriesEvent:

Instance Methods
(BOOL)	- isEqualToTimeSeriesEvent:
Instance Methods inherited from PTDiffusionTimeSeriesEventMetadata
(BOOL)	- isEqualToTimeSeriesEventMetadata:

Properties
PTDiffusionTimeSeriesEventMetadata *	originalEvent
BOOL	editEvent
PTDiffusionBytes *	bytes
Properties inherited from PTDiffusionTimeSeriesEventMetadata
UInt64	sequence
SInt64	timestamp
NSString *	author

Detailed Description

An event in a time series.

Two instances are equal if and only if they have identical attributes. Typically two instances that have the same sequence number will be equal, but this may not be true if the event has changed on the server.

Since

6.0

Method Documentation

isEqualToTimeSeriesEvent:

- (BOOL) isEqualToTimeSeriesEvent:

(nullable PTDiffusionTimeSeriesEvent *)

timeSeriesEvent

Compares the receiver to the given time series event.

Parameters

timeSeriesEvent

The time series event object with which to compare the receiver.

Returns

YES if it is identical to the receiver, otherwise NO.

Since

6.0

Property Documentation

bytes

- (PTDiffusionBytes*) bytes

readnonatomicassign

The value associated with the event.

Since

6.3

editEvent

- (BOOL) editEvent

readnonatomicassign

If this is an edit event then YES, otherwise NO indicating that this is an original event.

Since

6.0

originalEvent

- (PTDiffusionTimeSeriesEventMetadata*) originalEvent

readnonatomicassign

If this is an edit event, returns the metadata of the original event that this event replaces; otherwise returns this event.

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

Since

6.0