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

Class VecTopologySegment

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

A TopologySegment is a distance in the Topology where no intermediate electrical contacts appear. If a Topology contains routed wires, then the wire at the beginning of a TopologySegment have to be the same as in the ending.

Java class for TopologySegment complex type.

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


 <complexType name="TopologySegment">
   <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="Form" type="{http://www.prostep.org/ecad-if/2011/vec}SegmentForm"/>
         <element name="AliasId" type="{http://www.prostep.org/ecad-if/2011/vec}AliasIdentification" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ProcessingInstruction" type="{http://www.prostep.org/ecad-if/2011/vec}LocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="EndNode" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="StartNode" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="CrossSectionAreaInformation" type="{http://www.prostep.org/ecad-if/2011/vec}SegmentCrossSectionArea" maxOccurs="unbounded" minOccurs="0"/>
         <element name="LengthInformation" type="{http://www.prostep.org/ecad-if/2011/vec}SegmentLength" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the TopologySegment. The identification is guaranteed to be unique within the TopologySpecification. Over all VEC-documents a TopologySegment-instance can be trusted to be the same if the TopologySpecification-instance is the same (see TopologySpecification) and the identification of the TopologySegment is the same.

    • form

      protected String form

      Specifies the form of the TopologySegment. A TopologySegment can either be circular or noncircular.

    • aliasIds

      protected List<VecAliasIdentification> aliasIds

      Specifies additional identifiers for the TopologySegment.

      Example: TopologySegment Ids may vary from one CAD system export to another. Therefore the CAD system Id is improper for identification attribute. The identification shall have a value which is unique within the Topology. AliasId may be used for the CAD system Id.

    • processingInstructions

      protected List<VecLocalizedString> processingInstructions

      Specifies processing instructions for the TopologySegment.

    • endNode

      protected VecTopologyNode endNode

    • startNode

      protected VecTopologyNode startNode

    • crossSectionAreaInformations

      protected List<VecSegmentCrossSectionArea> crossSectionAreaInformations

    • lengthInformations

      protected List<VecSegmentLength> lengthInformations

  • Constructor Details

    • VecTopologySegment

      public VecTopologySegment()

  • Method Details

    • getIdentification

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

      Specifies a unique identification of the TopologySegment. The identification is guaranteed to be unique within the TopologySpecification. Over all VEC-documents a TopologySegment-instance can be trusted to be the same if the TopologySpecification-instance is the same (see TopologySpecification) and the identification of the TopologySegment is the same.

      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:

    • getForm

      public String getForm()
      Gets the value of the form property.

      Specifies the form of the TopologySegment. A TopologySegment can either be circular or noncircular.

      Returns:
      possible object is String

    • setForm

      public void setForm(String value)
      Sets the value of the form property.
      Parameters:
      value - allowed object is String
      See Also:

    • getAliasIds

      public List<VecAliasIdentification> getAliasIds()
      Gets the value of the aliasIds 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 aliasIds property.

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

          getAliasIds().add(newItem);

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

      Specifies additional identifiers for the TopologySegment.

      Example: TopologySegment Ids may vary from one CAD system export to another. Therefore the CAD system Id is improper for identification attribute. The identification shall have a value which is unique within the Topology. AliasId may be used for the CAD system Id.

      Returns:
      The value of the aliasIds property.

    • getProcessingInstructions

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

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

          getProcessingInstructions().add(newItem);

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

      Specifies processing instructions for the TopologySegment.

      Returns:
      The value of the processingInstructions property.

    • getEndNode

      public VecTopologyNode getEndNode()
      Gets the value of the endNode property.
      Returns:
      possible object is Object

    • setEndNode

      public void setEndNode(VecTopologyNode value)
      Sets the value of the endNode property.
      Parameters:
      value - allowed object is Object

    • getStartNode

      public VecTopologyNode getStartNode()
      Gets the value of the startNode property.
      Returns:
      possible object is Object

    • setStartNode

      public void setStartNode(VecTopologyNode value)
      Sets the value of the startNode property.
      Parameters:
      value - allowed object is Object

    • getCrossSectionAreaInformations

      public List<VecSegmentCrossSectionArea> getCrossSectionAreaInformations()
      Gets the value of the crossSectionAreaInformations 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 crossSectionAreaInformations property.

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

          getCrossSectionAreaInformations().add(newItem);

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

      Returns:
      The value of the crossSectionAreaInformations property.

    • getLengthInformations

      public List<VecSegmentLength> getLengthInformations()
      Gets the value of the lengthInformations 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 lengthInformations property.

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

          getLengthInformations().add(newItem);

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

      Returns:
      The value of the lengthInformations property.

    • getRefGeometrySegment

      public Set<VecGeometrySegment> getRefGeometrySegment()
      Gets a Set of all VecGeometrySegment 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.

    • getRefPath

      public Set<VecPath> getRefPath()
      Gets a Set of all VecPath 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.

    • getRefRouting

      public Set<VecRouting> getRefRouting()
      Gets a Set of all VecRouting 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.

    • getRefSegmentLocation

      public Set<VecSegmentLocation> getRefSegmentLocation()
      Gets a Set of all VecSegmentLocation 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.

    • getParentTopologySpecification

      public VecTopologySpecification getParentTopologySpecification()
      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 VecTopologySpecification 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