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

Class VecLocation

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecDimensionAnchor
com.foursoft.harness.vec.v113.VecLocation
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasIdentification, HasModifiableIdentification, Visitable, Serializable
Direct Known Subclasses:
VecNodeLocation, VecSegmentLocation
public abstract class VecLocation extends VecDimensionAnchor implements Serializable, HasIdentification, HasModifiableIdentification, Visitable

A Location specifies a distinct position on a topology. Locations can be used for the placement of components or for the definition of Dimensions.

Java class for Location complex type.

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


 <complexType name="Location">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}DimensionAnchor">
       <sequence>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="MatchingId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PlacedPlacementPoints" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

      Specifies a unique identification of the Location. The identification is guaranteed to be unique within the PlacementSpecification.

    • matchingId

      protected String matchingId

      Specifies an identification for matching the location with a reference point of component (e.g. a cable channel).

    • placedPlacementPoints

      protected List<VecPlacementPointReference> placedPlacementPoints

      References thePlacementPointReferencethat is placed by this location.

  • Constructor Details

    • VecLocation

      public VecLocation()

  • Method Details

    • getIdentification

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

      Specifies a unique identification of the Location. The identification is guaranteed to be unique within the PlacementSpecification.

      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:

    • getMatchingId

      public String getMatchingId()
      Gets the value of the matchingId property.

      Specifies an identification for matching the location with a reference point of component (e.g. a cable channel).

      Returns:
      possible object is String

    • setMatchingId

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

    • getPlacedPlacementPoints

      public List<VecPlacementPointReference> getPlacedPlacementPoints()
      Gets the value of the placedPlacementPoints 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 placedPlacementPoints property.

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

          getPlacedPlacementPoints().add(newItem);

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

      References thePlacementPointReferencethat is placed by this location.

    • getParentDimension

      public VecDimension getParentDimension()
      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 VecDimension 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.

    • getParentOnPointPlacement

      public VecOnPointPlacement getParentOnPointPlacement()
      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 VecOnPointPlacement 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.

    • getParentOnWayPlacement

      public VecOnWayPlacement getParentOnWayPlacement()
      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 VecOnWayPlacement 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.