SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Functions
Methods for managing superset/subset membership.

Primitive operations for subset/superset arrangements. More...

Functions

EntityRefsmtk::model::EntityRef::addMemberEntity (const EntityRef &memberToAdd)
 Add an entity as a member of this entity without any membership constraint checks.
 
EntityRefsmtk::model::EntityRef::removeMemberEntity (const EntityRef &memberToRemove)
 Remove the memberToRemove from this EntityRef. More...
 
EntityRefsmtk::model::EntityRef::removeMemberEntity (int indexOfMemberToRemove)
 Remove a member from this EntityRef given the index of its arrangement. More...
 
ResourceEventRelationType smtk::model::EntityRef::subsetRelationType (const EntityRef &member) const
 Determine the nature of a SUPERSET_OF relationship. More...
 

Detailed Description

Primitive operations for subset/superset arrangements.

These methods are intended to be used by subclasses such as Group and Model.

Function Documentation

◆ removeMemberEntity() [1/2]

EntityRef & smtk::model::EntityRef::removeMemberEntity ( const EntityRef memberToRemove)
protected

Remove the memberToRemove from this EntityRef.

No membership constraint checks are performed.

◆ removeMemberEntity() [2/2]

EntityRef & smtk::model::EntityRef::removeMemberEntity ( int  indexOfArrangementToRemove)
protected

Remove a member from this EntityRef given the index of its arrangement.

No membership constraint checks are performed.

Note that the indexOfArrangementToRemove is not an index into the Entity's relations, but an index into the Arrangement vector for the SUPERSET_OF relationship.

◆ subsetRelationType()

ResourceEventRelationType smtk::model::EntityRef::subsetRelationType ( const EntityRef member) const
protected

Determine the nature of a SUPERSET_OF relationship.

Given a SUPERSET_OF arrangement, use the types of the involved entities to determine the exact nature of the relationship. This is used by the event framework so that observers can watch for particular types of events.