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

Class VecRouting

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

A Routing is the assignment of a RoutableElement (Connection or WireElementReference) to a path in the topology.

Java class for Routing complex type.

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


 <complexType name="Routing">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ConfigurableElement">
       <sequence>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SpecialRoutedComment" type="{http://www.prostep.org/ecad-if/2011/vec}LocalizedString" minOccurs="0"/>
         <element name="SpecialRouted" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="MandatorySegment" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="RoutedElement" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="Path" type="{http://www.prostep.org/ecad-if/2011/vec}Path"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the Routing. The identification is guaranteed to be unique within the RoutingSpecification.

    • specialRoutedComment

      protected VecLocalizedString specialRoutedComment

      Allows the specification of an explanation why this routing has been routed in a special way.

    • specialRouted

      protected Boolean specialRouted

      Specifies that routing has been created in a special way. This means it has not been calculated in the standard way, because for some reason the result of the standard calculation has been inconvenient.

    • mandatorySegment

      protected List<VecTopologySegment> mandatorySegment

    • routedElement

      protected VecRoutableElement routedElement

    • path

      protected VecPath path

  • Constructor Details

    • VecRouting

      public VecRouting()

  • Method Details

    • getIdentification

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

      Specifies a unique identification of the Routing. The identification is guaranteed to be unique within the RoutingSpecification.

      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:

    • getSpecialRoutedComment

      public VecLocalizedString getSpecialRoutedComment()
      Gets the value of the specialRoutedComment property.

      Allows the specification of an explanation why this routing has been routed in a special way.

      Returns:
      possible object is VecLocalizedString

    • setSpecialRoutedComment

      public void setSpecialRoutedComment(VecLocalizedString value)
      Sets the value of the specialRoutedComment property.
      Parameters:
      value - allowed object is VecLocalizedString
      See Also:

    • isSpecialRouted

      public Boolean isSpecialRouted()
      Gets the value of the specialRouted property.

      Specifies that routing has been created in a special way. This means it has not been calculated in the standard way, because for some reason the result of the standard calculation has been inconvenient.

      Returns:
      possible object is Boolean

    • setSpecialRouted

      public void setSpecialRouted(Boolean value)
      Sets the value of the specialRouted property.
      Parameters:
      value - allowed object is Boolean
      See Also:

    • getRoutedElement

      public VecRoutableElement getRoutedElement()
      Gets the value of the routedElement property.
      Returns:
      possible object is Object

    • setRoutedElement

      public void setRoutedElement(VecRoutableElement value)
      Sets the value of the routedElement property.
      Parameters:
      value - allowed object is Object

    • getPath

      public VecPath getPath()
      Gets the value of the path property.
      Returns:
      possible object is VecPath

    • setPath

      public void setPath(VecPath value)
      Sets the value of the path property.
      Parameters:
      value - allowed object is VecPath

    • getMandatorySegment

      public List<VecTopologySegment> getMandatorySegment()
      Gets the value of the mandatorySegment 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 mandatorySegment property.

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

          getMandatorySegment().add(newItem);

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

    • getParentRoutingSpecification

      public VecRoutingSpecification getParentRoutingSpecification()
      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 VecRoutingSpecification 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