Public Member Functions

de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection Class Reference

AbstractConnection is the abstract super class for all connections: connection, delegation down, delegation up, bus connection, bus delegation More...

List of all members.

Public Member Functions

 AbstractConnection ()
 constructor
void addDataLink (AbstractDataLink newDataElementLink) throws AXLException
 Adds a data element link.
int compareTo (IAXLangElement axlOther)
 Define sorting order.
AbstractDataLink createDataLink (DataElement sourceDataElement, DataElement targetDataElement) throws AXLException
 Creates a data link with source and target data element and adds it to the connection.
Collection< AbstractDataLinkgetDataLinks ()
 Returns the data element links.
DataElement getOutputDataElement (DataElement input)
 maps a data element at the input port of the connection to the data element at the output port of the connection that is associated to the input via a data element link of the connection
abstract Port getSourcePort ()
 Returns the referenced source port.
LocalPortInstance getSourcePortInstance ()
 Returns the source port instance if it exists.
SubComponent getSourceSubComponent ()
 Returns the referenced source subcomponent.
abstract Port getTargetPort ()
 Returns the referenced target port.
LocalPortInstance getTargetPortInstance ()
 Returns the target port instance if it exists.
SubComponent getTargetSubComponent ()
 Returns the referenced target subcomponent.
boolean isConnection ()
 Returns if the connection is a connection, not a delegation.
boolean isDelegation ()
 Returns if the connection is a delegation.
boolean removeDataLink (AbstractDataLink dataLink)
 removes a data link
abstract boolean removeSourcePort (Port oldSourcePort)
 Removes the reference to the old source port.
abstract boolean removeTargetPort (Port oldTargetPort)
 Removes the reference to the old target port.
abstract void setSourcePort (Port newSourcePort) throws AXLException
 Sets the reference to the new source port.
void setSourcePortInstance (LocalPortInstance sourcePortInstance) throws AXLException
 Sets the source port instance, if it is possible.
void setSourceSubComponent (SubComponent subcomponent) throws AXLException
 sets the source subcomponent if possible
abstract void setTargetPort (Port newTargetPort) throws AXLException
 Sets the reference to the new target port.
void setTargetPortInstance (LocalPortInstance targetPortInstance) throws AXLException
 Sets the target port instance, if it is possible.
void setTargetSubComponent (SubComponent subcomponent) throws AXLException
 sets the target subcomponent if possible

Detailed Description

AbstractConnection is the abstract super class for all connections: connection, delegation down, delegation up, bus connection, bus delegation

Children
  • 0..* data link
Author:
mgrosse
ekleinod
Version:
0.10.0
Since:
0.1

Constructor & Destructor Documentation

de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.AbstractConnection (  ) 

constructor


Member Function Documentation

void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.addDataLink ( AbstractDataLink  newDataElementLink  )  throws AXLException

Adds a data element link.

Parameters:
newDataElementLink the new data element link
Exceptions:
AXLException if element could not be added
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0

Reimplemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection.

int de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.compareTo ( IAXLangElement  axlOther  ) 

Define sorting order.

Sorting order (smaller elements first):

  1. no source or target port defined
  2. kind (delegation before connections)
  3. Unterkomponente A
  4. Port A
  5. Unterkomponente B
  6. Port B
Parameters:
axlOther other element
Returns:
result of comparison
Return values:
<0 this element is less than the other
0 this element equals the other
>0 this element is greater than the other

Reimplemented from de.fraunhofer.isst.axbench.axlang.api.AbstractAXLangElement.

AbstractDataLink de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.createDataLink ( DataElement  sourceDataElement,
DataElement  targetDataElement 
) throws AXLException

Creates a data link with source and target data element and adds it to the connection.

Parameters:
sourceDataElement the new source data element
targetDataElement the new target data element
Returns:
the created data link
Exceptions:
AXLException if element could not be added
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0
Collection<AbstractDataLink> de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getDataLinks (  ) 

Returns the data element links.

Returns:
the collection of data element links
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0
DataElement de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getOutputDataElement ( DataElement  input  ) 

maps a data element at the input port of the connection to the data element at the output port of the connection that is associated to the input via a data element link of the connection

Parameters:
input a data element from the input port of the connection
Returns:
the data element from the output port of the connection that the input is linked to
Return values:
null if no data element at the output port is linked to the input data element
abstract Port de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getSourcePort (  )  [pure virtual]
LocalPortInstance de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getSourcePortInstance (  ) 

Returns the source port instance if it exists.

Returns:
the source port instance if it exists, else null
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0

Reimplemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection.

SubComponent de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getSourceSubComponent (  ) 

Returns the referenced source subcomponent.

Returns:
referenced source subcomponent
Return values:
null if it does not exist
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0

Reimplemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection.

abstract Port de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getTargetPort (  )  [pure virtual]
LocalPortInstance de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getTargetPortInstance (  ) 

Returns the target port instance if it exists.

Returns:
the target port instance if it exists, else null
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0
SubComponent de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.getTargetSubComponent (  ) 

Returns the referenced target subcomponent.

Returns:
referenced target subcomponent
Return values:
null if it does not exist
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0
boolean de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.isConnection (  ) 

Returns if the connection is a connection, not a delegation.

Returns:
connection?
Return values:
true connection
false delegation
boolean de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.isDelegation (  ) 

Returns if the connection is a delegation.

Returns:
delegation?
Return values:
true delegation
false connection
boolean de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.removeDataLink ( AbstractDataLink  dataLink  ) 

removes a data link

Parameters:
dataLink the data link to be removed
Returns:
true if the data link could be removed, else false
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0
abstract boolean de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.removeSourcePort ( Port  oldSourcePort  )  [pure virtual]

Removes the reference to the old source port.

Parameters:
oldSourcePort the old source port
Returns:
true if the reference to the old source port could be removed, else false.

Implemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection, de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.Connection, de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.DelegationDown, and de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.DelegationUp.

abstract boolean de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.removeTargetPort ( Port  oldTargetPort  )  [pure virtual]
abstract void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setSourcePort ( Port  newSourcePort  )  throws AXLException [pure virtual]
void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setSourcePortInstance ( LocalPortInstance  sourcePortInstance  )  throws AXLException

Sets the source port instance, if it is possible.

Parameters:
the new source port instance
Exceptions:
AXLException if the source port instance cannot be set
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0

Reimplemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection.

void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setSourceSubComponent ( SubComponent  subcomponent  )  throws AXLException

sets the source subcomponent if possible

Parameters:
subcomponent the new source subcomponent
Exceptions:
AXLException if the source subcomponent cannot be set
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0

Reimplemented in de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractBusConnection.

abstract void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setTargetPort ( Port  newTargetPort  )  throws AXLException [pure virtual]
void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setTargetPortInstance ( LocalPortInstance  targetPortInstance  )  throws AXLException

Sets the target port instance, if it is possible.

Parameters:
the new target port instance
Exceptions:
AXLException if the source port instance cannot be set
Author:
mgrosse
Version:
0.10.0
Since:
0.9.0
void de.fraunhofer.isst.axbench.axlang.elements.architecturemodel.AbstractConnection.setTargetSubComponent ( SubComponent  subcomponent  )  throws AXLException

sets the target subcomponent if possible

Parameters:
subcomponent the new target subcomponent
Exceptions:
AXLException if the target subcomponent cannot be set
Author:
mgrosse
Version:
0.10.0
Since:
0.10.0