Package wt.wvs

Interface VisualizationHelperIfc

All Known Implementing Classes:
VisualizationHelper
public interface VisualizationHelperIfc
The VisualizationServiceIfc class provides abstract access to the methods in the com.ptc.wvs package classes from classes in wt. Implementations of this interface:
  • must provide a public default constructor which takes no arguments.
  • must not be stateful.


Supported API: true

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LINK_NAVIGATION_ALL
    Navigate all links.
    static final int
    LINK_NAVIGATION_DESCRIBE
    Navigate all EPMDescribeLink links.
    static final int
    LINK_NAVIGATION_NON_OWNER
    Navigate all EPMBuildHistory links that are not Owner associations links.
    static final int
    LINK_NAVIGATION_NON_PRIMARY_OWNER
    Navigate all EPMBuildHistory links that are Owner Associations and are not the Primary Owner Association links.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    copyToDescribedParts(WTCollection _sourceRepresentations, EPMDocument _targetEPMDocument, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
    Copy a collection of representations to all described parts.
    boolean
    copyToDescribedParts(Representation _sourceRepresentation, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
    Copies the source Representation to the described parts.
    boolean
    copyToDescribedParts(Representation _sourceRepresentation, EPMDocument _targetEPMDocument, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
    Copy a representation to all described parts.
    WTCollection
    findDescribedParts(EPMDocument _targetEPMDoc, int _linkNavigation, boolean _executeHook)
    Find described parts for the given EPMDocument.
    WTKeyedMap
    getAssemblyFeatureImpactList(WTSet reps, boolean includesSubtractiveAssemblyFeatureImpacts, boolean includesAdditiveAssemblyFeatures)
    Returns the EPMDocuments and WTParts that are impacted by any subtractive assembly features (e.g.
    WTSet
    getAssemblyFeatureImpactList(Representation rep, boolean includesSubtractiveAssemblyFeatureImpacts, boolean includesAdditiveAssemblyFeatures)
    Returns the EPMDocuments and WTParts that are impacted by any subtractive assembly features (e.g.
    String
    getSaveWVSObjectGatewayURL()
    Returns the Gateway URL to save representations and/or markups as zip or jar files.

  • Field Details

  • Method Details

    • findDescribedParts

      WTCollection findDescribedParts(EPMDocument _targetEPMDoc, int _linkNavigation, boolean _executeHook)
      Find described parts for the given EPMDocument.
      Parameters:
      _targetEPMDoc - The EPMDocument object to find all of the described parts for.
      _linkNavigation - Indicate which links should be used when doing the navigation from the given EPMDocument to the Described Parts. The following are supported values which can be concatenated together to indicate more than one link type (Bit Mask): LINK_NAVIGATION_NON_OWNER LINK_NAVIGATION_NON_PRIMARY_OWNER LINK_NAVIGATION_DESCRIBE LINK_NAVIGATION_ALL
      boolean - _executeHook Whether or not to execute a configured "Find Described Parts" hook. See wvs.properties.xconf for configuration information.

      Supported API: true

    • copyToDescribedParts

      boolean copyToDescribedParts(Representation _sourceRepresentation, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
      Copies the source Representation to the described parts.
      Parameters:
      _sourceRepresentation - Representation to copy from.
      _includeMarkUps - Copy all associated MarkUps associated to the representation.
      _defaultRepresentation - Should the source representation be the "default" in order to proceed with copying to all described parts.
      _requireOwnerLink - Should the target EPMDocument have a Owner link to a WTPart in order to proceed with copying to all described parts.
      _latestIteration - Should the target EPMDocument be the latest iteration in order to proceed with copying to all described parts.
      _linkNavigation - Indicate which links should be used when doing the navigation from the given EPMDocument to the Described Parts. The following are supported values which can be concatenated together to indicate more than one link type (Bit Mask): LINK_NAVIGATION_NON_OWNER LINK_NAVIGATION_NON_PRIMARY_OWNER LINK_NAVIGATION_DESCRIBE LINK_NAVIGATION_ALL
      Returns:
      boolean If the copy was successful

      Supported API: true

    • copyToDescribedParts

      boolean copyToDescribedParts(Representation _sourceRepresentation, EPMDocument _targetEPMDocument, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
      Copy a representation to all described parts.
      Parameters:
      _sourceRepresentation - Representation to copy from.
      _targetEPMDocument - The EPMDocument used to find associated described parts to copy the source representation to.
      _includeMarkUps - Copy all associated MarkUps associated to the representation.
      _defaultRepresentation - Should the source representation be the "default" in order to proceed with copying to all described parts.
      _requireOwnerLink - Should the target EPMDocument have a Owner link to a WTPart in order to proceed with copying to all described parts.
      _latestIteration - Should the target EPMDocument be the latest iteration in order to proceed with copying to all described parts.
      _linkNavigation - Indicate which links should be used when doing the navigation from the given EPMDocument to the Described Parts. The following are supported values which can be concatenated together to indicate more than one link type (Bit Mask): LINK_NAVIGATION_NON_OWNER LINK_NAVIGATION_NON_PRIMARY_OWNER LINK_NAVIGATION_DESCRIBE LINK_NAVIGATION_ALL
      Returns:
      boolean If the copy was successful

      Supported API: true

    • copyToDescribedParts

      boolean copyToDescribedParts(WTCollection _sourceRepresentations, EPMDocument _targetEPMDocument, boolean _includeMarkUps, boolean _defaultRepresentation, boolean _requireOwnerLink, boolean _latestIteration, int _linkNavigation)
      Copy a collection of representations to all described parts.
      Parameters:
      _sourceRepresentations - Collection of Representations to copy from.
      _targetEPMDocument - The EPMDocument used to find associated described parts to copy the source representations to.
      _includeMarkUps - Copy all associated MarkUps associated to the representations.
      _defaultRepresentation - Should the source representations be the "default" in order to proceed with copying to all described parts.
      _requireOwnerLink - Should the target EPMDocument have a Owner link to a WTPart in order to proceed with copying to all described parts.
      _latestIteration - Should the target EPMDocument be the latest iteration in order to proceed with copying to all described parts.
      _linkNavigation - Indicate which links should be used when doing the navigation from the given EPMDocument to the Described Parts. The following are supported values which can be concatenated together to indicate more than one link type (Bit Mask): LINK_NAVIGATION_NON_OWNER LINK_NAVIGATION_NON_PRIMARY_OWNER LINK_NAVIGATION_DESCRIBE LINK_NAVIGATION_ALL
      Returns:
      boolean If the copy was successful

      Supported API: true

    • getSaveWVSObjectGatewayURL

      String getSaveWVSObjectGatewayURL()
      Returns the Gateway URL to save representations and/or markups as zip or jar files. Following parameters are supported when invoking the returned URL:
      • oid - the oid of the target object to save. The target object is a Representation, a WTMarkUp, or a Representable whose dynamic structure representation is to be saved. Must be present.
      • fileType - either zip or jar. Must be present.
      • annotations - flag indicating if annotations are to be included; only applicable if the oid parameter is a Representation or a Representable. May be absent.
      • filter - oid of the navigation criteria; only applicable if the oid parameter is a Representable. May be absent.
      Returns:
      the Gateway URL to be used to save presentations or markups as zip or jar files. Returns null if error.

      Supported API: true

    • getAssemblyFeatureImpactList

      WTSet getAssemblyFeatureImpactList(Representation rep, boolean includesSubtractiveAssemblyFeatureImpacts, boolean includesAdditiveAssemblyFeatures) throws WTException
      Returns the EPMDocuments and WTParts that are impacted by any subtractive assembly features (e.g. cut-outs, holes) and/or the assemblies that contain additive assembly features (e.g. welds).

      Note that this API depends on a special property in the representation. The property, which indicates the presence of assembly features in the presentation of a CAD assembly, is set during publishing by certain CAD Object Adapters. Not all adapters support this feature.

      Parameters:
      rep - - the representation of a CAD assembly.
      includesSubtractiveAssemblyFeatureImpacts - - if true, returns all the parts impacted by subtractive assembly features.
      includesAdditiveAssemblyFeatures - - if true, returns the assemblies containting additive assembly features (e.g. welds) at any assembly level.
      Returns:
      all the parts and EPMDocuments impacted by subtractive assembly features and/or assemblies with additive assembly features. Returns null in any of the following cases:
      • the representation is not of an assembly.
      • neither boolean parameter passed in is true.
      • there is no assembly feature in the representation.
      • the assembly feature presence is unknown in the representation (i.e. the property is not set).
      Throws:
      WTException -

      Supported API: true

    • getAssemblyFeatureImpactList

      WTKeyedMap getAssemblyFeatureImpactList(WTSet reps, boolean includesSubtractiveAssemblyFeatureImpacts, boolean includesAdditiveAssemblyFeatures) throws WTException
      Returns the EPMDocuments and WTParts that are impacted by any subtractive assembly features (e.g. cut-outs, holes) and/or the assemblies that contain additive assembly features (e.g. welds).

      Note that this API depends on a special property in the representation. The property, which indicates the presence of assembly features in the presentation of a CAD assembly, is set during publishing by certain CAD Object Adapters. Not all adapters support this feature.

      Parameters:
      reps - - the representations of CAD assemblies.
      includesSubtractiveAssemblyFeatureImpacts - - if true, returns all the parts impacted by subtractive assembly features.
      includesAdditiveAssemblyFeatures - - if true, returns the assemblies containting additive assembly features (e.g. welds) at any assembly level.
      Returns:
      all the parts and EPMDocuments impacted by subtractive assembly features and/or assemblies with additive assembly features. The keys of the returned map are a subset of the representations passed into the API; the value of each map entry is a WTSet of impacted EPMDocuments and WTParts for the representation (i.e. map entry key).

      If there is no impact list for a representation for any of the following reasons, the representation is not included in the map:

      • the representation is not of an assembly.
      • there is no assembly feature in the representation.
      • the assembly feature presence is unknown in the representation (i.e. the property is not set).

      It returns null or an empty map in any of the following cases:

      • neither boolean parameter passed in is true.
      • None of the representations is an assembly representation.
      • there is no assembly feature in any of the representations.
      • the assembly feature presence is unknown in all representations (i.e. the property is not set).
      Throws:
      WTException -

      Supported API: true