org.eodisp.hla.crc.data
Interface Federate

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

FederateImpl

public interface Federate
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Federate'.

The following features are supported:

• Registered Object Instances
• Subscribed Attributes
• Subscribed Interactions
• Published Attributes
• Published Interactions
• Lrc Handle
• Handle
• Federation Execution
• Published Object Classes
• Subscribed Object Classes

See Also:

DataPackage.getFederate()

generated

model

Field Summary

static java.lang.String

copyright

Method Summary

void	checkPublication(ObjectClass objectClass) Checks if the given object class is published by this federate, throws an ObjectClassNotPublished otherwise.
void	checkPublication(java.util.Set<Attribute> attributes) Checks if the given attributes are published by this federate, throws a AttributeNotPublished exception otherwise.
FederationExecution	getFederationExecution() Returns the value of the 'Federation Execution' attribute.
FederateHandle	getHandle() Returns the value of the 'Handle' attribute.
LrcHandle	getLrcHandle() Returns the value of the 'Lrc Handle' attribute.
org.eclipse.emf.common.util.EList	getPublishedAttributes() Returns the value of the 'Published Attributes' reference list.
org.eclipse.emf.common.util.EList	getPublishedInteractions() Returns the value of the 'Published Interactions' reference list.
org.eclipse.emf.common.util.EList	getPublishedObjectClasses() Returns the value of the 'Published Object Classes' reference list.
org.eclipse.emf.common.util.EList	getRegisteredObjectInstances() Returns the value of the 'Registered Object Instances' containment reference list.
org.eclipse.emf.common.util.EList	getSubscribedAttributes() Returns the value of the 'Subscribed Attributes' reference list.
org.eclipse.emf.common.util.EList	getSubscribedInteractions() Returns the value of the 'Subscribed Interactions' reference list.
org.eclipse.emf.common.util.EList	getSubscribedObjectClasses() Returns the value of the 'Subscribed Object Classes' reference list.
boolean	ownsAttributes() Returns true if this federate owns at least one attribute, otherwise returns false.
boolean	ownsAttributes(ObjectInstance objectInstance, java.util.Set<Attribute> attributes) Returns true if this federate owns all of the given attributes.
void	setFederationExecution(FederationExecution value) Sets the value of the 'Federation Execution' attribute.
void	setHandle(FederateHandle value) Sets the value of the 'Handle' attribute.
void	setLrcHandle(LrcHandle value) Sets the value of the 'Lrc Handle' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Field Detail

copyright

static final java.lang.String copyright

See Also:

Constant Field Values

generated

Method Detail

getRegisteredObjectInstances

org.eclipse.emf.common.util.EList getRegisteredObjectInstances()

Returns the value of the 'Registered Object Instances' containment reference list. The list contents are of type ObjectInstance. It is bidirectional and its opposite is 'Registering Federate'.

If the meaning of the 'Registered Object Instances' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Registered Object Instances' containment reference list.

See Also:

DataPackage.getFederate_RegisteredObjectInstances(), ObjectInstance.getRegisteringFederate()

generated

model

type="org.eodisp.hla.crc.data.ObjectInstance" opposite="registeringFederate" containment="true"

getSubscribedAttributes

org.eclipse.emf.common.util.EList getSubscribedAttributes()

Returns the value of the 'Subscribed Attributes' reference list. The list contents are of type Attribute. It is bidirectional and its opposite is 'Subscribing Federates'.

If the meaning of the 'Subscribed Attributes' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Subscribed Attributes' reference list.

See Also:

DataPackage.getFederate_SubscribedAttributes(), Attribute.getSubscribingFederates()

generated

model

type="org.eodisp.hla.crc.omt.Attribute" opposite="subscribingFederates"

getSubscribedInteractions

org.eclipse.emf.common.util.EList getSubscribedInteractions()

Returns the value of the 'Subscribed Interactions' reference list. The list contents are of type InteractionClass. It is bidirectional and its opposite is 'Subscribing Federates'.

If the meaning of the 'Subscribed Interactions' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Subscribed Interactions' reference list.

See Also:

DataPackage.getFederate_SubscribedInteractions(), InteractionClass.getSubscribingFederates()

generated

model

type="org.eodisp.hla.crc.omt.InteractionClass" opposite="subscribingFederates"

getPublishedAttributes

org.eclipse.emf.common.util.EList getPublishedAttributes()

Returns the value of the 'Published Attributes' reference list. The list contents are of type Attribute. It is bidirectional and its opposite is 'Publishing Federates'.

If the meaning of the 'Published Attributes' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Published Attributes' reference list.

See Also:

DataPackage.getFederate_PublishedAttributes(), Attribute.getPublishingFederates()

generated

model

type="org.eodisp.hla.crc.omt.Attribute" opposite="publishingFederates"

getPublishedInteractions

org.eclipse.emf.common.util.EList getPublishedInteractions()

Returns the value of the 'Published Interactions' reference list. The list contents are of type InteractionClass. It is bidirectional and its opposite is 'Publishing Federates'.

If the meaning of the 'Published Interactions' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Published Interactions' reference list.

See Also:

DataPackage.getFederate_PublishedInteractions(), InteractionClass.getPublishingFederates()

generated

model

type="org.eodisp.hla.crc.omt.InteractionClass" opposite="publishingFederates"

getLrcHandle

LrcHandle getLrcHandle()

Returns the value of the 'Lrc Handle' attribute.

If the meaning of the 'Lrc Handle' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Lrc Handle' attribute.

See Also:

setLrcHandle(LrcHandle), DataPackage.getFederate_LrcHandle()

generated

model

dataType="org.eodisp.hla.crc.data.ELrcHandle" transient="true"

setLrcHandle

void setLrcHandle(LrcHandle value)

Sets the value of the 'Lrc Handle' attribute.

Parameters:

value - the new value of the 'Lrc Handle' attribute.

See Also:

getLrcHandle()

generated

getHandle

FederateHandle getHandle()

Returns the value of the 'Handle' attribute.

If the meaning of the 'Handle' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Handle' attribute.

See Also:

setHandle(FederateHandle), DataPackage.getFederate_Handle()

generated

model

dataType="org.eodisp.hla.crc.data.EFederateHandle"

setHandle

void setHandle(FederateHandle value)

Sets the value of the 'Handle' attribute.

Parameters:

value - the new value of the 'Handle' attribute.

See Also:

getHandle()

generated

getFederationExecution

FederationExecution getFederationExecution()

Returns the value of the 'Federation Execution' attribute.

If the meaning of the 'Federation Execution' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Federation Execution' attribute.

See Also:

setFederationExecution(FederationExecution), DataPackage.getFederate_FederationExecution()

generated

model

dataType="org.eodisp.hla.crc.data.EFederationExecution"

setFederationExecution

void setFederationExecution(FederationExecution value)

Sets the value of the 'Federation Execution' attribute.

Parameters:

value - the new value of the 'Federation Execution' attribute.

See Also:

getFederationExecution()

generated

getPublishedObjectClasses

org.eclipse.emf.common.util.EList getPublishedObjectClasses()

Returns the value of the 'Published Object Classes' reference list. The list contents are of type ObjectClass.

If the meaning of the 'Published Object Classes' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Published Object Classes' reference list.

See Also:

DataPackage.getFederate_PublishedObjectClasses()

generated

model

type="org.eodisp.hla.crc.omt.ObjectClass" transient="true" changeable="false" volatile="true" ordered="false"

getSubscribedObjectClasses

org.eclipse.emf.common.util.EList getSubscribedObjectClasses()

Returns the value of the 'Subscribed Object Classes' reference list. The list contents are of type ObjectClass.

If the meaning of the 'Subscribed Object Classes' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Subscribed Object Classes' reference list.

See Also:

DataPackage.getFederate_SubscribedObjectClasses()

generated

model

type="org.eodisp.hla.crc.omt.ObjectClass" transient="true" changeable="false" volatile="true" ordered="false"

checkPublication

void checkPublication(ObjectClass objectClass)
                      throws ObjectClassNotPublished

Checks if the given object class is published by this federate, throws an ObjectClassNotPublished otherwise.

Parameters:

objectClass - the object class to be checked for publiscation on this federate

Throws:

ObjectClassNotPublished - if the given object class is not published by this federate

generated

not

checkPublication

void checkPublication(java.util.Set<Attribute> attributes)
                      throws AttributeNotPublished

Checks if the given attributes are published by this federate, throws a AttributeNotPublished exception otherwise.

Parameters:

attributes - the attributes to be checked for publication on this federate

Throws:

AttributeNotPublished - if this federate is not publishing the given attributes

ownsAttributes

boolean ownsAttributes(ObjectInstance objectInstance,
                       java.util.Set<Attribute> attributes)

Returns true if this federate owns all of the given attributes. Currently this method tests if the given object instance has been registered by this federate. This is enough because it is not possible to aquire ownership for another federate if one federate has registered an object instance. This may change in the future, when more HLA service are implemented, in particular RTIambassador.attributeOwnershipAcquisition(ObjectInstanceHandle, AttributeHandleSet, byte[]). Note that this method declaration does not need be changed for this.

Parameters:

objectInstance - the object instance of that is registered for the given attributes

attributes - the attributes of the given object instance that shall be checked for ownership on this federate.

Returns:

true if this federate owns all of the given attributes of the given object instance

ownsAttributes

boolean ownsAttributes()

Returns true if this federate owns at least one attribute, otherwise returns false. Currently this method tests if any object instance has been registered by this federate. This is enough because it is not possible to aquire ownership for another federate if one federate has registered an object instance. This may change in the future, when more HLA service are implemented, in particular if the service RTIambassador.attributeOwnershipAcquisition(ObjectInstanceHandle, AttributeHandleSet, byte[]) is implemented. Note that this method declaration does not need be changed for this.

Returns:

true if this federate owns at least one attribute, otherwise returns false.