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

Class VecUsageNode

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

AUsageNoderepresents a position in an abstract vehicle. For example the "Head Light Left".UsageNodesbelong to the master data and they are defined on some companywide level. They can be used to enforce consistent naming over different projects and different development streams (e.g. between Geometry and Electrologic).

AUsageNodecan be realized by different elements in the VEC (e.g.NetworkNode, OccurrenceOrUsage, TopologyNode, ComponentNode).

Java class for UsageNode complex type.

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


 <complexType name="UsageNode">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ConfigurableElement">
       <sequence>
         <element name="Abbreviation" type="{http://www.prostep.org/ecad-if/2011/vec}LocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Identification" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Description" type="{http://www.prostep.org/ecad-if/2011/vec}AbstractLocalizedString" maxOccurs="unbounded" minOccurs="0"/>
         <element name="UsageNodeType" type="{http://www.prostep.org/ecad-if/2011/vec}UsageNodeType" minOccurs="0"/>
         <element name="UsedInProject" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="SubUsageNodes" type="{http://www.prostep.org/ecad-if/2011/vec}UsageNode" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • abbreviations

      protected List<VecLocalizedString> abbreviations

      Specifies an abbreviation of theUsageNode. Normally this a human readable short name.

    • identification

      protected String identification

      Specifies a uniqueidentificationof theUsageNode. Theidentificationis guaranteed to be unique within the context. Over all VEC-documents aUsageNode-instancecan be trusted to be the same if the context-instance is the same and theidentificationof theUsageNodeis the same.

    • descriptions

      protected List<VecAbstractLocalizedString> descriptions

      Specifies additional, human readable information about theUsageNode.

    • usageNodeType

      protected String usageNodeType

      Defines the type of the UsageNode. The type determines how the UsageNode is handled in the latter processes.

    • usedInProject

      protected List<VecProject> usedInProject

      Specifies theProjectsin which theUsageNodecan be used.

    • subUsageNodes

      protected List<VecUsageNode> subUsageNodes

  • Constructor Details

    • VecUsageNode

      public VecUsageNode()

  • Method Details

    • getAbbreviations

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

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

          getAbbreviations().add(newItem);

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

      Specifies an abbreviation of theUsageNode. Normally this a human readable short name.

      Returns:
      The value of the abbreviations property.

    • getIdentification

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

      Specifies a uniqueidentificationof theUsageNode. Theidentificationis guaranteed to be unique within the context. Over all VEC-documents aUsageNode-instancecan be trusted to be the same if the context-instance is the same and theidentificationof theUsageNodeis 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:

    • getDescriptions

      public List<VecAbstractLocalizedString> getDescriptions()
      Gets the value of the descriptions 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 descriptions property.

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

          getDescriptions().add(newItem);

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

      Specifies additional, human readable information about theUsageNode.

      Specified by:
      getDescriptions in interface HasDescription<VecAbstractLocalizedString>
      Returns:
      The value of the descriptions property.

    • getUsageNodeType

      public String getUsageNodeType()
      Gets the value of the usageNodeType property.

      Defines the type of the UsageNode. The type determines how the UsageNode is handled in the latter processes.

      Returns:
      possible object is String

    • setUsageNodeType

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

    • getSubUsageNodes

      public List<VecUsageNode> getSubUsageNodes()
      Gets the value of the subUsageNodes 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 subUsageNodes property.

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

          getSubUsageNodes().add(newItem);

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

      Returns:
      The value of the subUsageNodes property.

    • getRefComponentNode

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

    • getRefNetworkNode

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

    • getRefOccurrenceOrUsage

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

    • getRefTopologyNode

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

    • getRefUsageConstraint

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

    • getUsedInProject

      public List<VecProject> getUsedInProject()
      Gets the value of the usedInProject 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 usedInProject property.

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

          getUsedInProject().add(newItem);

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

      Specifies theProjectsin which theUsageNodecan be used.

    • getParentUsageNode

      public VecUsageNode getParentUsageNode()
      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 VecUsageNode 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.

    • getParentUsageNodeSpecification

      public VecUsageNodeSpecification getParentUsageNodeSpecification()
      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 VecUsageNodeSpecification 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