2.1.4 Data Distribution Management

2.1.4.1 Region Creation

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Region Creation} \drawfra... ...mess{deleteRegion}{m3}{m2} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

getRoutingSpaceHandle( spaceName): Returns routing space handle.
May raise NameNotFound, FederateNotExecutionMember, ConcurrentAccessAttempted.

getRoutingSpaceName( space): Returns routing space name.
May raise SpaceNotDefined, FederateNotExecutionMember, ConcurrentAccessAttempted.

getDimensionHandle( dimensionName, space): Returns routing space dimension handle.
May raise SpaceNotDefined, NameNotFound, FederateNotExecutionMember, ConcurrentAccessAttempted.

getDimensionName( dimension, space): Returns routing space dimension name.
May raise SpaceNotDefined, DimensionNotDefined, FederateNotExecutionMember, ConcurrentAccessAttempted.

createRegion( space, [dimension, (lower, upper)])

Returns region handle.

May raise SpaceNotDefined, InvalidExtents, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

notifyAboutRegionModification( region): May raise RegionNotKnown, InvalidExtents, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

deleteRegion( region): May raise RegionNotKnown, RegionInUse, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.4.2 Object Registration

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Object Management With Re... ...oveObjectInstance}{m2}{m3} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

subscribeObjectClassAttributesWithRegion( objectClass, region, (attribute), active=True): May raise ObjectClassNotDefined, AttributeNotDefined, RegionNotKnown, InvalidRegionContext, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

unsubscribeObjectClassWithRegion( objectClass, region): May raise ObjectClassNotDefined, RegionNotKnown, ObjectClassNotSubscribed, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

enableClassRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

disableClassRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

enableAttributeRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

disableAttributeRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

enableAttributeScopeAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

disableAttributeScopeAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

registerObjectInstanceWithRegion( objectClass, [(attribute, region)][, object])

Returns object handle.

May raise ObjectClassNotDefined, ObjectClassNotPublished, AttributeNotDefined, AttributeNotPublished, RegionNotKnown, InvalidRegionContext, ObjectAlreadyRegistered, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

associateRegionForUpdates( region, object, (attribute)): May raise ObjectNotKnown, AttributeNotDefined, InvalidRegionContext, RegionNotKnown, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

unassociateRegionForUpdates( region, object): May raise ObjectNotKnown, InvalidRegionContext, RegionNotKnown, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

getAttributeRoutingSpaceHandle( attribute, objectClass): Returns routing space handle.
May raise ObjectClassNotDefined, AttributeNotDefined, FederateNotExecutionMember, ConcurrentAccessAttempted.

requestClassAttributeValueUpdateWithRegion( objectClass, (attribute), region): May raise ObjectClassNotDefined, AttributeNotDefined, RegionNotKnown, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

attributesInScope( object, (attribute)): May raise ObjectNotKnown, AttributeNotKnown.

attributesOutOfScope( object, (attribute)): May raise ObjectNotKnown, AttributeNotKnown.

2.1.4.3 Exchanging Interactions

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Exchanging Interactions W... ...rnInteractionsOff}{m2}{m3} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

subscribeInteractionClassWithRegion( interactionClass, region, active=True): May raise InteractionClassNotDefined, RegionNotKnown, InvalidRegionContext, FederateLoggingServiceCalls, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

unsubscribeInteractionClassWithRegion( interactionClass, region): May raise InteractionClassNotDefined, InteractionClassNotSubscribed, RegionNotKnown, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

enableInteractionRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

disableInteractionRelevanceAdvisorySwitch( ): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

getInteractionRoutingSpaceHandle( interactionClass): Returns routing space handle.
May raise InteractionClassNotDefined, FederateNotExecutionMember, ConcurrentAccessAttempted.

sendInteractionWithRegion( interactionClass, parameter:value, region, tag[, time])

Returns eventRetraction handle.

May raise InteractionClassNotDefined, InteractionClassNotPublished, InteractionParameterNotDefined, InvalidFederationTime, RegionNotKnown, InvalidRegionContext, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.