swim.api.data.SpatialData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swim-api Show documentation

Agent programming interface

There is a newer version: 4.3.15

// Copyright 2015-2021 Swim Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package swim.api.data;

import swim.math.Z2Form;
import swim.spatial.SpatialMap;
import swim.structure.Form;
import swim.structure.Value;

public interface SpatialData extends SpatialMap {

  Value name();

  Form keyForm();

   SpatialData keyForm(Form keyForm);

   SpatialData keyClass(Class keyClass);

  Z2Form shapeForm();

  Form valueForm();

   SpatialData valueForm(Form valueForm);

   SpatialData valueClass(Class valueClass);

  boolean isResident();

  SpatialData isResident(boolean isResident);

  boolean isTransient();

  SpatialData isTransient(boolean isTransient);

  SpatialMap snapshot();

  void close();

}