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

Class VecPlacement

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

A placement defines the placement of a PlaceableElementRole onto a Topology. For the definition of the place on the Topology, Locations are used. A Placement can either be a placement on discrete points (OnPointPlacement) or on an area of the topology (OnWayPlacement).

Java class for Placement complex type.

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


 <complexType name="Placement">
   <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="Type" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsOnTopOf" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="PlacedElement" type="{http://www.w3.org/2001/XMLSchema}IDREFS"/>
       </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.

    • type

      protected String type

      Room to specify additional type information of the placement.

    • isOnTopOf

      protected List<VecPlacement> isOnTopOf

    • placedElement

      protected List<VecPlaceableElementRole> placedElement

  • Constructor Details

    • VecPlacement

      public VecPlacement()

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

    • getType

      public String getType()
      Gets the value of the type property.

      Room to specify additional type information of the placement.

      Returns:
      possible object is String

    • setType

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

    • getIsOnTopOf

      public List<VecPlacement> getIsOnTopOf()
      Gets the value of the isOnTopOf 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 isOnTopOf property.

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

          getIsOnTopOf().add(newItem);

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

    • getRefPlacement

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

    • getPlacedElement

      public List<VecPlaceableElementRole> getPlacedElement()
      Gets the value of the placedElement 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 placedElement property.

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

          getPlacedElement().add(newItem);

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

    • getParentPlacementSpecification

      public VecPlacementSpecification getParentPlacementSpecification()
      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 VecPlacementSpecification 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.