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

Class VecWireElementSpecification

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

A WireElementSpecification is the basic element to describe a wire in the VEC. A WireElementSpecification can be atomic or composed recursively out of other WireElementSpecifications. A WireElementSpecification can reference an InsulationSpecification, if it has an insulation, a CoreSpecification, if it has a core or a WireGroupSpecification if it is a grouping of other WireElementSpecifications in the Wire (e.g. a multi-core wire with twisted pairs).

Java class for WireElementSpecification complex type.

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


 <complexType name="WireElementSpecification">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}Specification">
       <sequence>
         <element name="Type" type="{http://www.prostep.org/ecad-if/2011/vec}WireType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="MinBendRadiusDynamic" type="{http://www.prostep.org/ecad-if/2011/vec}NumericalValue" minOccurs="0"/>
         <element name="MinBendRadiusStatic" type="{http://www.prostep.org/ecad-if/2011/vec}NumericalValue" minOccurs="0"/>
         <element name="OutsideDiameter" type="{http://www.prostep.org/ecad-if/2011/vec}NumericalValue" minOccurs="0"/>
         <element name="SuitedForDynamicUse" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Impedance" type="{http://www.prostep.org/ecad-if/2011/vec}NumericalValue" minOccurs="0"/>
         <element name="Size" type="{http://www.prostep.org/ecad-if/2011/vec}Size" minOccurs="0"/>
         <element name="ValidWireReceptionTypes" type="{http://www.prostep.org/ecad-if/2011/vec}WireReceptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="GridSpacing" type="{http://www.prostep.org/ecad-if/2011/vec}NumericalValue" minOccurs="0"/>
         <element name="Shape" type="{http://www.prostep.org/ecad-if/2011/vec}WireElementShape" minOccurs="0"/>
         <element name="ConductorSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="FillerSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="InsulationSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
         <element name="SubWireElementSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="WireGroupSpecification" type="{http://www.w3.org/2001/XMLSchema}IDREF" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • types

      protected List<VecWireType> types

      Defines the type of the wire. A wire must not have more than one type. This attribute allows more than one value for the reason, that the same type can be expressed in multiple reference systems.

    • minBendRadiusDynamic

      protected VecNumericalValue minBendRadiusDynamic

      Specifies the minimum bend radius for wire element, if it is used in a dynamic environment, where it is bended repeatedly (e.g in grommet of the back door). (see KLBFRM-311)

    • minBendRadiusStatic

      protected VecNumericalValue minBendRadiusStatic

      Specifies the minimum bend radius for wire element, if it is used in a static environment, where it is bended once during installation. After that it remains unchanged in its bended position during usage. (see KLBFRM-311)

    • outsideDiameter

      protected VecNumericalValue outsideDiameter

      Specifies the outside diameter of the WireElement.

    • suitedForDynamicUse

      protected Boolean suitedForDynamicUse

      Specifies if it is allowed to use the WireElement in a dynamic environment. (see KBLFRM-311)

    • impedance

      protected VecNumericalValue impedance

      Defines the impedance of this wireElement. Typically used for WireElements that have subWireElements e.g. twisted pair or coax wires.

    • size

      protected VecSize size

      Defines the size of a WireElement if it has not the shape of circle. If it has the shape of a circle the size is normally defined by its outside diameter.

    • validWireReceptionTypes

      protected List<String> validWireReceptionTypes

      Defines theWireReceptionTypesthat are allowed for joining with the specifiedWireElement.

    • gridSpacing

      protected VecNumericalValue gridSpacing

      Defines the grid spacing. The grid spacing is the distance between the centers of two adjacent sub wire elements.

      This attribute is only valid forWireElementSpecificationsthat haveSubWireElementSpecifications.

    • shape

      protected String shape

      Defines the shape of anWireElement.Circular wire elements are defined by their outsideDiameter, all others are defined by their size.

    • conductorSpecification

      protected VecConductorSpecification conductorSpecification

      If theWireElementhas a core then the specification of the core is referenced here.

    • fillerSpecification

      protected VecFillerSpecification fillerSpecification

      If theWireElementis a filler then the specification of the filler is referenced here.

    • insulationSpecification

      protected VecInsulationSpecification insulationSpecification

      If theWireElementhas an insulation then the specification of the insulation is referenced here.

    • subWireElementSpecification

      protected List<VecWireElementSpecification> subWireElementSpecification

    • wireGroupSpecification

      protected VecWireGroupSpecification wireGroupSpecification

      If theWireElementis a member of a wire group then the specification of the wire group is referenced here.

  • Constructor Details

    • VecWireElementSpecification

      public VecWireElementSpecification()

  • Method Details

    • getTypes

      public List<VecWireType> getTypes()
      Gets the value of the types 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 types property.

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

          getTypes().add(newItem);

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

      Defines the type of the wire. A wire must not have more than one type. This attribute allows more than one value for the reason, that the same type can be expressed in multiple reference systems.

      Returns:
      The value of the types property.

    • getMinBendRadiusDynamic

      public VecNumericalValue getMinBendRadiusDynamic()
      Gets the value of the minBendRadiusDynamic property.

      Specifies the minimum bend radius for wire element, if it is used in a dynamic environment, where it is bended repeatedly (e.g in grommet of the back door). (see KLBFRM-311)

      Returns:
      possible object is VecNumericalValue

    • setMinBendRadiusDynamic

      public void setMinBendRadiusDynamic(VecNumericalValue value)
      Sets the value of the minBendRadiusDynamic property.
      Parameters:
      value - allowed object is VecNumericalValue
      See Also:

    • getMinBendRadiusStatic

      public VecNumericalValue getMinBendRadiusStatic()
      Gets the value of the minBendRadiusStatic property.

      Specifies the minimum bend radius for wire element, if it is used in a static environment, where it is bended once during installation. After that it remains unchanged in its bended position during usage. (see KLBFRM-311)

      Returns:
      possible object is VecNumericalValue

    • setMinBendRadiusStatic

      public void setMinBendRadiusStatic(VecNumericalValue value)
      Sets the value of the minBendRadiusStatic property.
      Parameters:
      value - allowed object is VecNumericalValue
      See Also:

    • getOutsideDiameter

      public VecNumericalValue getOutsideDiameter()
      Gets the value of the outsideDiameter property.

      Specifies the outside diameter of the WireElement.

      Returns:
      possible object is VecNumericalValue

    • setOutsideDiameter

      public void setOutsideDiameter(VecNumericalValue value)
      Sets the value of the outsideDiameter property.
      Parameters:
      value - allowed object is VecNumericalValue
      See Also:

    • isSuitedForDynamicUse

      public Boolean isSuitedForDynamicUse()
      Gets the value of the suitedForDynamicUse property.

      Specifies if it is allowed to use the WireElement in a dynamic environment. (see KBLFRM-311)

      Returns:
      possible object is Boolean

    • setSuitedForDynamicUse

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

    • getImpedance

      public VecNumericalValue getImpedance()
      Gets the value of the impedance property.

      Defines the impedance of this wireElement. Typically used for WireElements that have subWireElements e.g. twisted pair or coax wires.

      Returns:
      possible object is VecNumericalValue

    • setImpedance

      public void setImpedance(VecNumericalValue value)
      Sets the value of the impedance property.
      Parameters:
      value - allowed object is VecNumericalValue
      See Also:

    • getSize

      public VecSize getSize()
      Gets the value of the size property.

      Defines the size of a WireElement if it has not the shape of circle. If it has the shape of a circle the size is normally defined by its outside diameter.

      Returns:
      possible object is VecSize

    • setSize

      public void setSize(VecSize value)
      Sets the value of the size property.
      Parameters:
      value - allowed object is VecSize
      See Also:

    • getValidWireReceptionTypes

      public List<String> getValidWireReceptionTypes()
      Gets the value of the validWireReceptionTypes 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 validWireReceptionTypes property.

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

          getValidWireReceptionTypes().add(newItem);

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

      Defines theWireReceptionTypesthat are allowed for joining with the specifiedWireElement.

      Returns:
      The value of the validWireReceptionTypes property.

    • getGridSpacing

      public VecNumericalValue getGridSpacing()
      Gets the value of the gridSpacing property.

      Defines the grid spacing. The grid spacing is the distance between the centers of two adjacent sub wire elements.

      This attribute is only valid forWireElementSpecificationsthat haveSubWireElementSpecifications.

      Returns:
      possible object is VecNumericalValue

    • setGridSpacing

      public void setGridSpacing(VecNumericalValue value)
      Sets the value of the gridSpacing property.
      Parameters:
      value - allowed object is VecNumericalValue
      See Also:

    • getShape

      public String getShape()
      Gets the value of the shape property.

      Defines the shape of anWireElement.Circular wire elements are defined by their outsideDiameter, all others are defined by their size.

      Returns:
      possible object is String

    • setShape

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

    • getConductorSpecification

      public VecConductorSpecification getConductorSpecification()
      Gets the value of the conductorSpecification property.

      If theWireElementhas a core then the specification of the core is referenced here.

      Returns:
      possible object is Object

    • setConductorSpecification

      public void setConductorSpecification(VecConductorSpecification value)
      Sets the value of the conductorSpecification property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getFillerSpecification

      public VecFillerSpecification getFillerSpecification()
      Gets the value of the fillerSpecification property.

      If theWireElementis a filler then the specification of the filler is referenced here.

      Returns:
      possible object is Object

    • setFillerSpecification

      public void setFillerSpecification(VecFillerSpecification value)
      Sets the value of the fillerSpecification property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getInsulationSpecification

      public VecInsulationSpecification getInsulationSpecification()
      Gets the value of the insulationSpecification property.

      If theWireElementhas an insulation then the specification of the insulation is referenced here.

      Returns:
      possible object is Object

    • setInsulationSpecification

      public void setInsulationSpecification(VecInsulationSpecification value)
      Sets the value of the insulationSpecification property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getWireGroupSpecification

      public VecWireGroupSpecification getWireGroupSpecification()
      Gets the value of the wireGroupSpecification property.

      If theWireElementis a member of a wire group then the specification of the wire group is referenced here.

      Returns:
      possible object is Object

    • setWireGroupSpecification

      public void setWireGroupSpecification(VecWireGroupSpecification value)
      Sets the value of the wireGroupSpecification property.
      Parameters:
      value - allowed object is Object
      See Also:

    • getRefWireElement

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

    • getSubWireElementSpecification

      public List<VecWireElementSpecification> getSubWireElementSpecification()
      Gets the value of the subWireElementSpecification 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 subWireElementSpecification property.

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

          getSubWireElementSpecification().add(newItem);

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

    • getRefWireElementSpecification

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

    • getRefWireSpecification

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

    • accept

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