nrel.hive.model.membership

Module Contents

Classes

Membership

class representing a collection of membership ids.

Attributes

PUBLIC_MEMBERSHIP_ID

nrel.hive.model.membership.PUBLIC_MEMBERSHIP_ID = 'public'

class nrel.hive.model.membership.Membership

Bases: NamedTuple

class representing a collection of membership ids.

property public: bool

memberships: FrozenSet[nrel.hive.util.typealiases.MembershipId]

classmethod from_tuple(member_ids: Tuple[nrel.hive.util.typealiases.MembershipId, Ellipsis]) → Membership

build membership from tuple.

Parameters:

member_ids –

Returns:

classmethod single_membership(membership_id: nrel.hive.util.typealiases.MembershipId) → Membership

build membership with single member id

Parameters:

membership_id –

Returns:

add_membership(membership_id: nrel.hive.util.typealiases.MembershipId) → Membership

add a single membership id

Parameters:

membership_id –

Returns:

memberships_in_common(other_membership: Membership) → FrozenSet[nrel.hive.util.typealiases.MembershipId]

lists the MembershipIds in common with another Membership, such as to identify which ride hail service provider was used to pick up a request

Parameters:

other_membership – the memberships of another entity in the simulation

Returns:

the memberships in common

grant_access_to_membership(other_membership: Membership) → bool

returns true if another membership has access to this membership

Parameters:

other_membership –

Returns:

grant_access_to_membership_id(membership_id: nrel.hive.util.typealiases.MembershipId) → bool

returns true if the membership id is valid for this membership

Parameters:

membership_id –

Returns:

as_tuple() → Tuple[nrel.hive.util.typealiases.MembershipId, Ellipsis]

__str__()

string representation of memberships :return: a comma-delimited string of the membership ids

to_json()