Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eodisp.hla.crc.omt
Interface InteractionClass

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
InteractionClassImpl
public interface InteractionClass
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Interaction Class'.

The following features are supported:

See Also:
OmtPackage.getInteractionClass()
generated
model
extendedMetaData="name='InteractionClass' kind='elementOnly'"

Field Summary
static java.lang.String copyright
           
static java.lang.String HLA_INTERACTION_ROOT_NAME
          The name of the HLA interaction root.
 
Method Summary
 java.util.List getAllParameters()
          Returns all parameters including parameters of all super classes.
 java.util.List<InteractionClass> getAllSuperClasses()
          Returns all super classes in an ordered list.
 java.util.List getDimensions()
          Returns the value of the 'Dimensions' attribute.
 java.util.List getDimensionsNotes()
          Returns the value of the 'Dimensions Notes' attribute.
 InteractionClassHandle getHandle()
          Returns the handle of this interaction class.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 java.util.List getNameNotes()
          Returns the value of the 'Name Notes' attribute.
 OrderEnum getOrder()
          Returns the value of the 'Order' attribute.
 java.util.List getOrderNotes()
          Returns the value of the 'Order Notes' attribute.
 org.eclipse.emf.common.util.EList getParameters()
          Returns the value of the 'Parameters' containment reference list.
 org.eclipse.emf.common.util.EList getPublishingFederates()
          Returns the value of the 'Publishing Federates' reference list.
 java.lang.String getQualifiedName(boolean omitInteractionRoot)
          Returns the fully qualified name of this interaction class.
 java.lang.Object getSemantics()
          Returns the value of the 'Semantics' attribute.
 java.util.List getSemanticsNotes()
          Returns the value of the 'Semantics Notes' attribute.
 SharingEnum getSharing()
          Returns the value of the 'Sharing' attribute.
 java.util.List getSharingNotes()
          Returns the value of the 'Sharing Notes' attribute.
 org.eclipse.emf.common.util.EList getSubClasses()
          Returns the value of the 'Sub Classes' containment reference list.
 org.eclipse.emf.common.util.EList getSubscribingFederates()
          Returns the value of the 'Subscribing Federates' reference list.
 InteractionClass getSuperClass()
          Returns the super class of this interaction class.
 java.lang.String getTransportation()
          Returns the value of the 'Transportation' attribute.
 java.util.List getTransportationNotes()
          Returns the value of the 'Transportation Notes' attribute.
 boolean isSetOrder()
          Returns whether the value of the 'Order' attribute is set.
 boolean isSetSharing()
          Returns whether the value of the 'Sharing' attribute is set.
 void setDimensions(java.util.List value)
          Sets the value of the 'Dimensions' attribute.
 void setDimensionsNotes(java.util.List value)
          Sets the value of the 'Dimensions Notes' attribute.
 void setHandle(InteractionClassHandle interactionClassHandle)
          Sets the handle of this interaction class.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setNameNotes(java.util.List value)
          Sets the value of the 'Name Notes' attribute.
 void setOrder(OrderEnum value)
          Sets the value of the 'Order' attribute.
 void setOrderNotes(java.util.List value)
          Sets the value of the 'Order Notes' attribute.
 void setSemantics(java.lang.Object value)
          Sets the value of the 'Semantics' attribute.
 void setSemanticsNotes(java.util.List value)
          Sets the value of the 'Semantics Notes' attribute.
 void setSharing(SharingEnum value)
          Sets the value of the 'Sharing' attribute.
 void setSharingNotes(java.util.List value)
          Sets the value of the 'Sharing Notes' attribute.
 void setTransportation(java.lang.String value)
          Sets the value of the 'Transportation' attribute.
 void setTransportationNotes(java.util.List value)
          Sets the value of the 'Transportation Notes' attribute.
 void unsetOrder()
          Unsets the value of the 'Order' attribute.
 void unsetSharing()
          Unsets the value of the 'Sharing' 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

HLA_INTERACTION_ROOT_NAME

static final java.lang.String HLA_INTERACTION_ROOT_NAME
The name of the HLA interaction root. See section 4.3.1 in IEEE 1516.2-2000, Page 25, first paragraph.

See Also:
Constant Field Values
Method Detail

getAllParameters

java.util.List getAllParameters()
Returns all parameters including parameters of all super classes.

Returns:
all parameter of this and all super classes

getParameters

org.eclipse.emf.common.util.EList getParameters()
Returns the value of the 'Parameters' containment reference list. The list contents are of type Parameter.

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

Returns:
the value of the 'Parameters' containment reference list.
See Also:
OmtPackage.getInteractionClass_Parameters()
generated
model
type="org.eodisp.hla.crc.omt.Parameter" containment="true" extendedMetaData="kind='element' name='parameter' namespace='##targetNamespace'"

getSubClasses

org.eclipse.emf.common.util.EList getSubClasses()
Returns the value of the 'Sub Classes' containment reference list. The list contents are of type InteractionClass.

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

Returns:
the value of the 'Sub Classes' containment reference list.
See Also:
OmtPackage.getInteractionClass_SubClasses()
generated
model
type="org.eodisp.hla.crc.omt.InteractionClass" containment="true" extendedMetaData="kind='element' name='interactionClass' namespace='##targetNamespace'"

getHandle

InteractionClassHandle getHandle()
Returns the handle of this interaction class.

Returns:
the handle of this interaction class.

setHandle

void setHandle(InteractionClassHandle interactionClassHandle)
Sets the handle of this interaction class. TODO: Should be set when constructing

Parameters:
interactionClassHandle -

getSuperClass

InteractionClass getSuperClass()
Returns the super class of this interaction class.

Returns:
the super class of this interaction class or null if this interaction class does not have a super class

getAllSuperClasses

java.util.List<InteractionClass> getAllSuperClasses()
Returns all super classes in an ordered list. The first element in the list is the immediate super class, the last the top most class, which is always the HLAobjectRoot

Returns:
all super classes of this interaction class

getDimensions

java.util.List getDimensions()
Returns the value of the 'Dimensions' attribute.

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

Returns:
the value of the 'Dimensions' attribute.
See Also:
setDimensions(List), OmtPackage.getInteractionClass_Dimensions()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='dimensions' namespace='##targetNamespace'"

setDimensions

void setDimensions(java.util.List value)
Sets the value of the 'Dimensions' attribute.

Parameters:
value - the new value of the 'Dimensions' attribute.
See Also:
getDimensions()
generated

getDimensionsNotes

java.util.List getDimensionsNotes()
Returns the value of the 'Dimensions Notes' attribute.

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

Returns:
the value of the 'Dimensions Notes' attribute.
See Also:
setDimensionsNotes(List), OmtPackage.getInteractionClass_DimensionsNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='dimensionsNotes' namespace='##targetNamespace'"

setDimensionsNotes

void setDimensionsNotes(java.util.List value)
Sets the value of the 'Dimensions Notes' attribute.

Parameters:
value - the new value of the 'Dimensions Notes' attribute.
See Also:
getDimensionsNotes()
generated

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

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

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), OmtPackage.getInteractionClass_Name()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKEN" required="true" extendedMetaData="kind='attribute' name='name' namespace='##targetNamespace'"

getQualifiedName

java.lang.String getQualifiedName(boolean omitInteractionRoot)
Returns the fully qualified name of this interaction class. See section 10.1.1 in IEEE 1516.1-2000.

Parameters:
omitInteractionRoot - if true omits the topmost super class HLAinteractionRoot.
Returns:
the fully qualified name of this interaction class. Delimiter is a dot(.).

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()
generated

getNameNotes

java.util.List getNameNotes()
Returns the value of the 'Name Notes' attribute.

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

Returns:
the value of the 'Name Notes' attribute.
See Also:
setNameNotes(List), OmtPackage.getInteractionClass_NameNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='nameNotes' namespace='##targetNamespace'"

setNameNotes

void setNameNotes(java.util.List value)
Sets the value of the 'Name Notes' attribute.

Parameters:
value - the new value of the 'Name Notes' attribute.
See Also:
getNameNotes()
generated

getOrder

OrderEnum getOrder()
Returns the value of the 'Order' attribute. The default value is "Receive". The literals are from the enumeration OrderEnum.

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

Returns:
the value of the 'Order' attribute.
See Also:
OrderEnum, isSetOrder(), unsetOrder(), setOrder(OrderEnum), OmtPackage.getInteractionClass_Order()
generated
model
default="Receive" unique="false" unsettable="true" extendedMetaData="kind='attribute' name='order' namespace='##targetNamespace'"

setOrder

void setOrder(OrderEnum value)
Sets the value of the 'Order' attribute.

Parameters:
value - the new value of the 'Order' attribute.
See Also:
OrderEnum, isSetOrder(), unsetOrder(), getOrder()
generated

unsetOrder

void unsetOrder()
Unsets the value of the 'Order' attribute.

See Also:
isSetOrder(), getOrder(), setOrder(OrderEnum)
generated

isSetOrder

boolean isSetOrder()
Returns whether the value of the 'Order' attribute is set.

Returns:
whether the value of the 'Order' attribute is set.
See Also:
unsetOrder(), getOrder(), setOrder(OrderEnum)
generated

getOrderNotes

java.util.List getOrderNotes()
Returns the value of the 'Order Notes' attribute.

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

Returns:
the value of the 'Order Notes' attribute.
See Also:
setOrderNotes(List), OmtPackage.getInteractionClass_OrderNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='orderNotes' namespace='##targetNamespace'"

setOrderNotes

void setOrderNotes(java.util.List value)
Sets the value of the 'Order Notes' attribute.

Parameters:
value - the new value of the 'Order Notes' attribute.
See Also:
getOrderNotes()
generated

getSemantics

java.lang.Object getSemantics()
Returns the value of the 'Semantics' attribute.

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

Returns:
the value of the 'Semantics' attribute.
See Also:
setSemantics(Object), OmtPackage.getInteractionClass_Semantics()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.AnySimpleType" extendedMetaData="kind='attribute' name='semantics' namespace='##targetNamespace'"

setSemantics

void setSemantics(java.lang.Object value)
Sets the value of the 'Semantics' attribute.

Parameters:
value - the new value of the 'Semantics' attribute.
See Also:
getSemantics()
generated

getSemanticsNotes

java.util.List getSemanticsNotes()
Returns the value of the 'Semantics Notes' attribute.

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

Returns:
the value of the 'Semantics Notes' attribute.
See Also:
setSemanticsNotes(List), OmtPackage.getInteractionClass_SemanticsNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='semanticsNotes' namespace='##targetNamespace'"

setSemanticsNotes

void setSemanticsNotes(java.util.List value)
Sets the value of the 'Semantics Notes' attribute.

Parameters:
value - the new value of the 'Semantics Notes' attribute.
See Also:
getSemanticsNotes()
generated

getSharing

SharingEnum getSharing()
Returns the value of the 'Sharing' attribute. The default value is "Publish". The literals are from the enumeration SharingEnum.

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

Returns:
the value of the 'Sharing' attribute.
See Also:
SharingEnum, isSetSharing(), unsetSharing(), setSharing(SharingEnum), OmtPackage.getInteractionClass_Sharing()
generated
model
default="Publish" unique="false" unsettable="true" extendedMetaData="kind='attribute' name='sharing' namespace='##targetNamespace'"

setSharing

void setSharing(SharingEnum value)
Sets the value of the 'Sharing' attribute.

Parameters:
value - the new value of the 'Sharing' attribute.
See Also:
SharingEnum, isSetSharing(), unsetSharing(), getSharing()
generated

unsetSharing

void unsetSharing()
Unsets the value of the 'Sharing' attribute.

See Also:
isSetSharing(), getSharing(), setSharing(SharingEnum)
generated

isSetSharing

boolean isSetSharing()
Returns whether the value of the 'Sharing' attribute is set.

Returns:
whether the value of the 'Sharing' attribute is set.
See Also:
unsetSharing(), getSharing(), setSharing(SharingEnum)
generated

getSharingNotes

java.util.List getSharingNotes()
Returns the value of the 'Sharing Notes' attribute.

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

Returns:
the value of the 'Sharing Notes' attribute.
See Also:
setSharingNotes(List), OmtPackage.getInteractionClass_SharingNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='sharingNotes' namespace='##targetNamespace'"

setSharingNotes

void setSharingNotes(java.util.List value)
Sets the value of the 'Sharing Notes' attribute.

Parameters:
value - the new value of the 'Sharing Notes' attribute.
See Also:
getSharingNotes()
generated

getTransportation

java.lang.String getTransportation()
Returns the value of the 'Transportation' attribute.

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

Returns:
the value of the 'Transportation' attribute.
See Also:
setTransportation(String), OmtPackage.getInteractionClass_Transportation()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKEN" extendedMetaData="kind='attribute' name='transportation' namespace='##targetNamespace'"

setTransportation

void setTransportation(java.lang.String value)
Sets the value of the 'Transportation' attribute.

Parameters:
value - the new value of the 'Transportation' attribute.
See Also:
getTransportation()
generated

getTransportationNotes

java.util.List getTransportationNotes()
Returns the value of the 'Transportation Notes' attribute.

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

Returns:
the value of the 'Transportation Notes' attribute.
See Also:
setTransportationNotes(List), OmtPackage.getInteractionClass_TransportationNotes()
generated
model
unique="false" dataType="org.eclipse.emf.ecore.xml.type.NMTOKENS" many="false" extendedMetaData="kind='attribute' name='transportationNotes' namespace='##targetNamespace'"

setTransportationNotes

void setTransportationNotes(java.util.List value)
Sets the value of the 'Transportation Notes' attribute.

Parameters:
value - the new value of the 'Transportation Notes' attribute.
See Also:
getTransportationNotes()
generated

getSubscribingFederates

org.eclipse.emf.common.util.EList getSubscribingFederates()
Returns the value of the 'Subscribing Federates' reference list. The list contents are of type Federate. It is bidirectional and its opposite is 'Subscribed Interactions'.

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

Returns:
the value of the 'Subscribing Federates' reference list.
See Also:
OmtPackage.getInteractionClass_SubscribingFederates(), Federate.getSubscribedInteractions()
generated
model
type="org.eodisp.hla.crc.data.Federate" opposite="subscribedInteractions" transient="true"

getPublishingFederates

org.eclipse.emf.common.util.EList getPublishingFederates()
Returns the value of the 'Publishing Federates' reference list. The list contents are of type Federate. It is bidirectional and its opposite is 'Published Interactions'.

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

Returns:
the value of the 'Publishing Federates' reference list.
See Also:
OmtPackage.getInteractionClass_PublishingFederates(), Federate.getPublishedInteractions()
generated
model
type="org.eodisp.hla.crc.data.Federate" opposite="publishedInteractions" transient="true"
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD