ServiceTimeInfo Class

Member Function Documentation

ServiceTimeInfo::ServiceTimeInfo()

Default constructor.

ServiceTimeInfo::ServiceTimeInfo(const Esri::ArcGISRuntime::ServiceTimeInfo &other)

Copy constructor from other ServiceTimeInfo.

ServiceTimeInfo::ServiceTimeInfo(Esri::ArcGISRuntime::ServiceTimeInfo &&other)

Move constructor from other ServiceTimeInfo.

ServiceTimeInfo::~ServiceTimeInfo()

Descructor.

[since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TimeValue ServiceTimeInfo::defaultInterval() const

Returns the default time interval for the service. This can be used as a time slider's step size.

Will return empty if an error occurs or if the service doesn't define a default time interval.

This function was introduced in Esri::ArcGISRuntime 100.3.

bool ServiceTimeInfo::hasLiveData() const

Returns if the service has live data.

If true, export and identify operations will default the TimeExtent to startTime = (current server time - time interval), endTime = current server time.

See also timeWindow.

[since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TimeExtent ServiceTimeInfo::timeExtent() const

Returns the time extent that includes all of the data in the layer.

The time extent of the service. Will return empty if an error occurs or if the service is not time aware.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::TimeReference ServiceTimeInfo::timeReference() const

Returns the time reference for the service.

Will return empty if an error occurs or if the service has no time reference.

Esri::ArcGISRuntime::TimeRelation ServiceTimeInfo::timeRelation() const

Returns the time relation for the service.

This can be used for determining how a time slider's start and end time are processed.

[since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::TimeValue ServiceTimeInfo::timeWindow() const

Returns the default time window for the service to use for a time slider.

Will return empty if an error occurs or if the service doesn't define a default time window. If this value is empty, then the time slider should create and use a time extent for an instant in time (start time = end time), if it is greater than 0 this value should be used as the difference between the start time and end time.

This function was introduced in Esri::ArcGISRuntime 200.1.

See also hasLiveData.

[since Esri::ArcGISRuntime 200.2] bool ServiceTimeInfo::operator!=(const Esri::ArcGISRuntime::ServiceTimeInfo &other) const

Inequality operator. Returns true if this object and other are not equal.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also ServiceTimeInfo::operator==.

Esri::ArcGISRuntime::ServiceTimeInfo &ServiceTimeInfo::operator=(const Esri::ArcGISRuntime::ServiceTimeInfo &other)

Assignment operator from other ServiceTimeInfo.

Esri::ArcGISRuntime::ServiceTimeInfo &ServiceTimeInfo::operator=(Esri::ArcGISRuntime::ServiceTimeInfo &&other)

Move operator from other ServiceTimeInfo.

[since Esri::ArcGISRuntime 200.1] bool ServiceTimeInfo::operator==(const Esri::ArcGISRuntime::ServiceTimeInfo &other) const

Returns a bool that tests if this object is equal to a second ServiceTimeInfo object.

• other - The second object.

This function was introduced in Esri::ArcGISRuntime 200.1.