Module com.foursoft.harness.vec.v113
Package com.foursoft.harness.vec.v113

Class VecComponentPort

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecConfigurableElement
com.foursoft.harness.vec.v113.VecComponentPort
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, Visitable, Serializable
public class VecComponentPort extends VecConfigurableElement implements Serializable, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, Visitable

Defines a port of ComponentNode. A ComponentPort is usually the realization of a NetworkPort. Electrological connections are defined between two or more ComponentPorts.

Java class for ComponentPort complex type.

The following schema fragment specifies the expected content contained within this class. 


 <complexType name="ComponentPort">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ConfigurableElement">
       <sequence>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="SignalDirection" type="{http://www.prostep.org/ecad-if/2011/vec}SignalDirection" minOccurs="0"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="NetworkPort" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="Signal" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the ComponentPort. The identification is guaranteed to be unique within the ComponentConnector.

    • signalDirection

      protected VecSignalDirection signalDirection

      Specifies the direction of the signal on this ComponentPort.

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Room for additional, human readable information about the ComponentPort.

    • networkPort

      protected VecNetworkPort networkPort

    • signal

      protected VecSignal signal

      References theSignalthat is associated with theComponentPort.

  • Constructor Details

    • VecComponentPort

      public VecComponentPort()

  • Method Details

    • getIdentification

      public String getIdentification()
      Gets the value of the identification property.

      Specifies a unique identification of the ComponentPort. The identification is guaranteed to be unique within the ComponentConnector.

      Specified by:
      getIdentification in interface HasIdentification
      Returns:
      possible object is String

    • setIdentification

      public void setIdentification(String value)
      Sets the value of the identification property.
      Specified by:
      setIdentification in interface HasModifiableIdentification
      Parameters:
      value - allowed object is String
      See Also:

    • getSignalDirection

      public VecSignalDirection getSignalDirection()
      Gets the value of the signalDirection property.

      Specifies the direction of the signal on this ComponentPort.

      Returns:
      possible object is VecSignalDirection

    • setSignalDirection

      public void setSignalDirection(VecSignalDirection value)
      Sets the value of the signalDirection property.
      Parameters:
      value - allowed object is VecSignalDirection
      See Also:

    • getDescriptions

      public List<VecAbstractLocalizedString> getDescriptions()
      Gets the value of the descriptions property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the descriptions property.

      For example, to add a new item, do as follows: 

          getDescriptions().add(newItem);

      Objects of the following type(s) are allowed in the list VecAbstractLocalizedString

      Room for additional, human readable information about the ComponentPort.

      Specified by:
      getDescriptions in interface HasDescription<VecAbstractLocalizedString>
      Returns:
      The value of the descriptions property.

    • getNetworkPort

      public VecNetworkPort getNetworkPort()
      Gets the value of the networkPort property.
      Returns:
      possible object is Object

    • setNetworkPort

      public void setNetworkPort(VecNetworkPort value)
      Sets the value of the networkPort property.
      Parameters:
      value - allowed object is Object

    • getSignal

      public VecSignal getSignal()
      Gets the value of the signal property.

      References theSignalthat is associated with theComponentPort.

      Returns:
      possible object is Object

    • setSignal

      public void setSignal(VecSignal value)
      Sets the value of the signal property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getRefCavityReference

      public Set<VecCavityReference> getRefCavityReference()
      Gets a Set of all VecCavityReference that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefConnectionEnd

      public Set<VecConnectionEnd> getRefConnectionEnd()
      Gets a Set of all VecConnectionEnd that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefTerminalRole

      public Set<VecTerminalRole> getRefTerminalRole()
      Gets a Set of all VecTerminalRole that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getParentComponentConnector

      public VecComponentConnector getParentComponentConnector()
      Gets a reference to the parent of this object in the XML DOM Tree. If this class can have different parents in DOM, this property is initialized with the parent, if the parent is a VecComponentConnector otherwise it will be null.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • accept

      public <R, E extends Throwable> R accept(Visitor<R,E> aVisitor) throws E
      Specified by:
      accept in interface Visitable
      Throws:
      E extends Throwable