Class VecComponentNode

All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasDescription<VecAbstractLocalizedString>, HasIdentification, HasModifiableIdentification, Visitable, Serializable

A ComponentNode is a node where an electrological component is located. It is a representative for an element in the electric system, e.g. an actuator, a sensor, an ECU. In this way it is quite similar to a NetworkNode and may even reference the corresponding NetworkNode in this case. However, a ComponentNode is more likely to be used as a representative of an inliner or a splice. Moreover, a ComponentNode can define childNodes in order to describe its internal structure.

Java class for ComponentNode complex type.

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


 <complexType name="ComponentNode">
   <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="Abbreviation" type="{http://www.prostep.org/ecad-if/2011/vec}LocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ComponentNodeType" type="{http://www.prostep.org/ecad-if/2011/vec}ComponentNodeType" minOccurs="0"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="NetworkNode" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="RealizedUsageNode" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="ChildNode" type="{http://www.prostep.org/ecad-if/2011/vec}ComponentNode" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ComponentConnector" type="{http://www.prostep.org/ecad-if/2011/vec}ComponentConnector" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 
See Also:
  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the ComponentNode. The identification is guaranteed to be unique within the ConnectionSpecification.

    • abbreviations

      protected List<VecLocalizedString> abbreviations

      Room for a short name of the ComponentNode.

    • componentNodeType

      protected String componentNodeType

      Specifies the type of the ComponentNode.

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Room for additional, human readable information about the ComponentNode.

    • networkNode

      protected VecNetworkNode networkNode
    • realizedUsageNode

      protected VecUsageNode realizedUsageNode

      References theUsageNodethat is realized by thisComponentNode.

    • childNodes

      protected List<VecComponentNode> childNodes
    • componentConnectors

      protected List<VecComponentConnector> componentConnectors
  • Constructor Details

    • VecComponentNode

      public VecComponentNode()
  • Method Details

    • getIdentification

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

      Specifies a unique identification of the ComponentNode. The identification is guaranteed to be unique within the ConnectionSpecification.

      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:
    • getAbbreviations

      public List<VecLocalizedString> getAbbreviations()
      Gets the value of the abbreviations 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 abbreviations property.

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

          getAbbreviations().add(newItem);
       

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

      Room for a short name of the ComponentNode.

      Returns:
      The value of the abbreviations property.
    • getComponentNodeType

      public String getComponentNodeType()
      Gets the value of the componentNodeType property.

      Specifies the type of the ComponentNode.

      Returns:
      possible object is String
    • setComponentNodeType

      public void setComponentNodeType(String value)
      Sets the value of the componentNodeType property.
      Parameters:
      value - allowed object is String
      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 ComponentNode.

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

      public VecNetworkNode getNetworkNode()
      Gets the value of the networkNode property.
      Returns:
      possible object is Object
    • setNetworkNode

      public void setNetworkNode(VecNetworkNode value)
      Sets the value of the networkNode property.
      Parameters:
      value - allowed object is Object
    • getRealizedUsageNode

      public VecUsageNode getRealizedUsageNode()
      Gets the value of the realizedUsageNode property.

      References theUsageNodethat is realized by thisComponentNode.

      Returns:
      possible object is Object
    • setRealizedUsageNode

      public void setRealizedUsageNode(VecUsageNode value)
      Sets the value of the realizedUsageNode property.
      Parameters:
      value - allowed object is Object
      See Also:
    • getChildNodes

      public List<VecComponentNode> getChildNodes()
      Gets the value of the childNodes 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 childNodes property.

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

          getChildNodes().add(newItem);
       

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

      Returns:
      The value of the childNodes property.
    • getComponentConnectors

      public List<VecComponentConnector> getComponentConnectors()
      Gets the value of the componentConnectors 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 componentConnectors property.

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

          getComponentConnectors().add(newItem);
       

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

      Returns:
      The value of the componentConnectors property.
    • getRefConnectorHousingRole

      public Set<VecConnectorHousingRole> getRefConnectorHousingRole()
      Gets a Set of all VecConnectorHousingRole 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.
    • getRefEEComponentRole

      public Set<VecEEComponentRole> getRefEEComponentRole()
      Gets a Set of all VecEEComponentRole 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.
    • getParentComponentNode

      public VecComponentNode getParentComponentNode()
      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 VecComponentNode 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.
    • getParentConnectionSpecification

      public VecConnectionSpecification getParentConnectionSpecification()
      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 VecConnectionSpecification 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