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

Class VecDimension

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

A Dimension defines a measurement for the distance between two Locations. An acceptable tolerance can be specified additionally. If the Locations are not located on adjacent topology-elements it is possible to specify a Path for the dimension along which the measurement must be taken.

The value for the Dimension is not specified as Numerical_value (which can define a Tolerance as well). This is because the "valueComponent" of the Numerical_value is mandatory. For Dimensions it shall be optional since there are scenarios where the dimension only specifies a Tolerance for a distance defined by the topology (segment length + placement information).

Java class for Dimension complex type.

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


 <complexType name="Dimension">
   <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="ValueComponent" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="ValueCalculated" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="DimensionAnchor" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="ReferenceAnchor" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="UnitComponent" type="{http://www.w3.org/2001/XMLSchema}IDREF"/>
         <element name="DefinedLocations" type="{http://www.prostep.org/ecad-if/2011/vec}Location" maxOccurs="2" minOccurs="0"/>
         <element name="Path" type="{http://www.prostep.org/ecad-if/2011/vec}Path" minOccurs="0"/>
         <element name="Tolerance" type="{http://www.prostep.org/ecad-if/2011/vec}Tolerance" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • identification

      protected String identification

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

    • valueComponent

      protected Double valueComponent

      Defines the value of the dimension. This value can be null, if it shall be calculated and only a tolerance shall be defined.

    • valueCalculated

      protected Boolean valueCalculated

      Defines if the value of theDimensionwas calculated (e.g. the sum of segment lengths in the topology) or if it was defined manually.

    • dimensionAnchor

      protected VecDimensionAnchor dimensionAnchor

      References the location that is used as dimension point for the dimensioning (e.g. the entry point of a bundle into a connector housing).

      See KBLFRM-329 and KBLFRM-391.

    • referenceAnchor

      protected VecDimensionAnchor referenceAnchor

      References the location that is used as reference point for the dimensioning (e.g. the location of a fixing as this relates to a fixpoint of the body in white).

      See KBLFRM-329 and KBLFRM-391.

    • unitComponent

      protected VecUnit unitComponent

    • definedLocations

      protected List<VecLocation> definedLocations

    • path

      protected VecPath path

    • tolerance

      protected VecTolerance tolerance

  • Constructor Details

    • VecDimension

      public VecDimension()

  • Method Details

    • getIdentification

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

      Specifies a unique identification of the Dimension. The identification is guaranteed to be unique within the containing 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:

    • getValueComponent

      public Double getValueComponent()
      Gets the value of the valueComponent property.

      Defines the value of the dimension. This value can be null, if it shall be calculated and only a tolerance shall be defined.

      Returns:
      possible object is Double

    • setValueComponent

      public void setValueComponent(Double value)
      Sets the value of the valueComponent property.
      Parameters:
      value - allowed object is Double
      See Also:

    • isValueCalculated

      public Boolean isValueCalculated()
      Gets the value of the valueCalculated property.

      Defines if the value of theDimensionwas calculated (e.g. the sum of segment lengths in the topology) or if it was defined manually.

      Returns:
      possible object is Boolean

    • setValueCalculated

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

    • getDimensionAnchor

      public VecDimensionAnchor getDimensionAnchor()
      Gets the value of the dimensionAnchor property.

      References the location that is used as dimension point for the dimensioning (e.g. the entry point of a bundle into a connector housing).

      See KBLFRM-329 and KBLFRM-391.

      Returns:
      possible object is Object

    • setDimensionAnchor

      public void setDimensionAnchor(VecDimensionAnchor value)
      Sets the value of the dimensionAnchor property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getReferenceAnchor

      public VecDimensionAnchor getReferenceAnchor()
      Gets the value of the referenceAnchor property.

      References the location that is used as reference point for the dimensioning (e.g. the location of a fixing as this relates to a fixpoint of the body in white).

      See KBLFRM-329 and KBLFRM-391.

      Returns:
      possible object is Object

    • setReferenceAnchor

      public void setReferenceAnchor(VecDimensionAnchor value)
      Sets the value of the referenceAnchor property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getUnitComponent

      public VecUnit getUnitComponent()
      Gets the value of the unitComponent property.
      Returns:
      possible object is Object

    • setUnitComponent

      public void setUnitComponent(VecUnit value)
      Sets the value of the unitComponent property.
      Parameters:
      value - allowed object is Object

    • getDefinedLocations

      public List<VecLocation> getDefinedLocations()
      Gets the value of the definedLocations 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 definedLocations property.

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

          getDefinedLocations().add(newItem);

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

      Returns:
      The value of the definedLocations property.

    • 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

    • getTolerance

      public VecTolerance getTolerance()
      Gets the value of the tolerance property.
      Returns:
      possible object is VecTolerance

    • setTolerance

      public void setTolerance(VecTolerance value)
      Sets the value of the tolerance property.
      Parameters:
      value - allowed object is VecTolerance

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

    • accept

      public <R, E extends Throwable> R accept(Visitor<R,E> aVisitor) throws E
      Specified by:
      accept in interface Visitable
      Throws:
      E extends Throwable