Class Scope

• Defined in File Scope.h

Class Documentation

class Scope

Data representation for a scope in a space.

Scopes represent different channels in a space which objects can exist in. This allows csp/mcs to only reason about objects in specific scopes.

Public Members

csp::common::String Id

The unique identifier of the scope.

This is set internally by MCS.

csp::common::String ReferenceId

The id of the object this scope relates to.

This is currently always the space id.

csp::common::String ReferenceType

The type of object this scope relates to.

This is currently always “GroupId”, as it references the space.

csp::common::String Name

The name of the scope, this should be a human readable string to identify the scope.

PubSubModelType PubSubType = PubSubModelType::Global

The pub/sub model of the scope.

This allows us define a global scope for the entire space, or a scope with a position and size. See csp::systems::PubSubModelType for more details.

double SolveRadius = 0.0

Determines the size of the scope using the radius from the object in meters.

This is only used when PubSubType is set to “Object”.

bool ManagedLeaderElection = false

Determines whether server side leader election is enabled on this scope.

If this is true, MCS will automatically determine the leader for this scope.