2.1.6 Time Management

2.1.6.1 Time Management Policy

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Time Management Policy} \... ...leTimeConstrained}{m1}{m2} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

enableTimeRegulation( federateTime, lookahead): May raise TimeRegulationAlreadyEnabled, EnableTimeRegulationPending, TimeAdvanceAlreadyInProgress, InvalidFederationTime, InvalidLookahead, ConcurrentAccessAttempted, FederateNotExecutionMember, SaveInProgress, RestoreInProgress.

timeRegulationEnabled( time): May raise InvalidFederationTime, EnableTimeRegulationWasNotPending.

timeConstrainedEnabled( time): May raise InvalidFederationTime, EnableTimeConstrainedWasNotPending.

timeAdvanceGrant( time): May raise InvalidFederationTime, TimeAdvanceWasNotInProgress.

requestRetraction( eventRetraction): May raise EventNotKnown.

disableTimeRegulation( ): May raise TimeRegulationWasNotEnabled, ConcurrentAccessAttempted, FederateNotExecutionMember, SaveInProgress, RestoreInProgress.

enableTimeConstrained( ): May raise TimeConstrainedAlreadyEnabled, EnableTimeConstrainedPending, TimeAdvanceAlreadyInProgress, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

disableTimeConstrained( ): May raise TimeConstrainedWasNotEnabled, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.6.2 Time Step Advancement

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Time Step Advancement} \d... ...{timeAdvanceGrant}{m2}{m1} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

timeAdvanceRequest( time): May raise InvalidFederationTime, FederationTimeAlreadyPassed, TimeAdvanceAlreadyInProgress, EnableTimeRegulationPending, EnableTimeConstrainedPending, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

timeAdvanceRequestAvailable( time): May raise InvalidFederationTime, FederationTimeAlreadyPassed, TimeAdvanceAlreadyInProgress, EnableTimeRegulationPending, EnableTimeConstrainedPending, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.6.3 Event-Based Advancement

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Event-Based Advancement} ... ...{timeAdvanceGrant}{m2}{m3} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

nextEventRequest( time): May raise InvalidFederationTime, FederationTimeAlreadyPassed, TimeAdvanceAlreadyInProgress, EnableTimeRegulationPending, EnableTimeConstrainedPending, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

nextEventRequestAvailable( time): May raise InvalidFederationTime, FederationTimeAlreadyPassed, TimeAdvanceAlreadyInProgress, EnableTimeRegulationPending, EnableTimeConstrainedPending, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.6.4 Optimistic Advancement

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Optimistic Advancement} \... ...{timeAdvanceGrant}{m2}{m3} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

flushQueueRequest( time): May raise InvalidFederationTime, FederationTimeAlreadyPassed, TimeAdvanceAlreadyInProgress, EnableTimeRegulationPending, EnableTimeConstrainedPending, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.6.5 Time Queries

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Time Queries} \drawframe{... ...yMinNextTimeEvent}{m1}{m2} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

queryLBTS( ): Returns the time.
May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

queryFederateTime( ): Returns the time.
May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

queryMinNextEventTime( ): Returns the time.
May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

modifyLookahead( lookahead): May raise InvalidLookahead, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

queryLookahead( ): Returns the time.
May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

retract( eventRetraction): May raise InvalidRetractionHandle, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

getOrderingHandle( orderingName): Returns ordering handle.
May raise NameNotFound, FederateNotExecutionMember, ConcurrentAccessAttempted.

getOrderingName( ordering): Returns ordering name.
May raise InvalidOrderingHandle, FederateNotExecutionMember, ConcurrentAccessAttempted.

changeAttributeOrderType( object, (attribute), ordering): May raise ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, InvalidOrderingHandle, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

changeInteractionOrderType( interactionClass, ordering): May raise InteractionClassNotDefined, InteractionClassNotPublished, InvalidOrderingHandle, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

2.1.6.6 Federation Synchronization

$\begin{figure}\centering \pagecolor{white} \begin{msc}{Federation Synchronizatio... ...ationSynchronized}{m2}{m3} \nextlevel \end{msc}\textcolor{white}{.} \end{figure}$

registerFederationSynchronizationPoint( label, tag[, (federate)]): May raise FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

synchronizationPointAchieved( label): May raise SynchronizationPointLabelWasNotAnnounced, FederateNotExecutionMember, ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress.

synchronizationPointRegistrationSucceeded( label)

synchronizationPointRegistrationFailed( label)

announceSynchronizationPoint( label, tag)

federationSynchronized( label)