wt.part
Class PartUsesOccurrence

java.lang.Object
  wt.part.PartUsesOccurrence

All Implemented Interfaces:

Externalizable, Serializable, wt.build.BuildableObject, wt.build.BuildableOccurrence, Releasable, NetFactor, ObjectMappable, Persistable, Occurrence, UsesOccurrence

public final class PartUsesOccurrence
extends Object
implements UsesOccurrence, wt.build.BuildableOccurrence, Releasable, Externalizable

This UsesOccurrence has, in addition to its name attribute, positioning information that can be used by visualization to position the CAD drawing within the CAD drawing of its parent.

Use the newPartUsesOccurrence static factory method(s), not the PartUsesOccurrence constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from interface wt.occurrence.UsesOccurrence

USES_NAME, USES_OCCURRENCE_IDENTIFIER

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Method Summary

void	clearTransform() Sets the Transform to a zero-like Java3D matrix.
String	getName() Gets the value of the attribute: NAME.
Vector	getOccurrenceDataVector() Gets the value of the attribute: OCCURRENCE_DATA_VECTOR.
String	getUsesName() Gets the value of the attribute: USES_NAME.
long	getUsesOccurrenceIdentifier() Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.
protected void	initialize(OccurrenceableLink occurrenceableLink) Supports initialization, following construction of an instance.
protected void	initialize(OccurrenceableLink occurrenceableLink, javax.vecmath.Matrix4d transform) Supports initialization, following construction of an instance.
protected void	initialize(PartUsesOccurrence original) Supports initialization, following construction of an instance.
boolean	isPlaceholder() Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.
static PartUsesOccurrence	newPartUsesOccurrence(OccurrenceableLink occurrenceableLink) This constructor returns a PartUsesOccurrence associated to the given OccurrenceableLink (normally a WTPartUsageLink) and with no transform.
static PartUsesOccurrence	newPartUsesOccurrence(OccurrenceableLink occurrenceableLink, javax.vecmath.Matrix4d transform) This constructor returns a PartUsesOccurrence associated to the given OccurrenceableLink normally a WTPartUsageLink) and with the given transform.
static PartUsesOccurrence	newPartUsesOccurrence(PartUsesOccurrence original) This constructor returns a copy of the PartUsesOccurrence passed to it.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOccurrenceDataVector(Vector a_OccurrenceDataVector) Sets the value of the attribute: OCCURRENCE_DATA_VECTOR.
void	setTransform(javax.vecmath.Matrix4d transform) Sets the Transform to the given Java3D matrix.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier) Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.
javax.vecmath.Matrix4d	toMatrix4d() Returns a Java 3D matrix for this Transform.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

toMatrix4d

public javax.vecmath.Matrix4d toMatrix4d()

Returns a Java 3D matrix for this Transform.

Supported API: true

Returns:

Matrix4d

setTransform

public void setTransform(javax.vecmath.Matrix4d transform)

Sets the Transform to the given Java3D matrix.

Supported API: true

Parameters:

transform -

clearTransform

public void clearTransform()
                    throws WTPropertyVetoException

Sets the Transform to a zero-like Java3D matrix.

Supported API: true

Throws:

WTPropertyVetoException

newPartUsesOccurrence

public static PartUsesOccurrence newPartUsesOccurrence(PartUsesOccurrence original)
                                                throws WTException,
                                                       WTPropertyVetoException

This constructor returns a copy of the PartUsesOccurrence passed to it.

Supported API: true

Parameters:

original -

Returns:

PartUsesOccurrence

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(PartUsesOccurrence original)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

original -

Throws:

WTException

WTPropertyVetoException

newPartUsesOccurrence

public static PartUsesOccurrence newPartUsesOccurrence(OccurrenceableLink occurrenceableLink)
                                                throws WTException,
                                                       WTPropertyVetoException

This constructor returns a PartUsesOccurrence associated to the given OccurrenceableLink (normally a WTPartUsageLink) and with no transform.

Supported API: true

Parameters:

occurrenceableLink -

Returns:

PartUsesOccurrence

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(OccurrenceableLink occurrenceableLink)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

occurrenceableLink -

Throws:

WTException

WTPropertyVetoException

newPartUsesOccurrence

public static PartUsesOccurrence newPartUsesOccurrence(OccurrenceableLink occurrenceableLink,
                                                       javax.vecmath.Matrix4d transform)
                                                throws WTException,
                                                       WTPropertyVetoException

This constructor returns a PartUsesOccurrence associated to the given OccurrenceableLink normally a WTPartUsageLink) and with the given transform.

Supported API: true

Parameters:

occurrenceableLink -

transform -

Returns:

PartUsesOccurrence

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(OccurrenceableLink occurrenceableLink,
                          javax.vecmath.Matrix4d transform)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

occurrenceableLink -

transform -

Throws:

WTException

WTPropertyVetoException

getUsesOccurrenceIdentifier

public long getUsesOccurrenceIdentifier()

Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Specified by:

getUsesOccurrenceIdentifier in interface UsesOccurrence

Returns:

long

setUsesOccurrenceIdentifier

public void setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier)
                                 throws WTPropertyVetoException

Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Specified by:

setUsesOccurrenceIdentifier in interface UsesOccurrence

Parameters:

a_UsesOccurrenceIdentifier -

Throws:

WTPropertyVetoException

getUsesName

public String getUsesName()

Gets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Specified by:

getUsesName in interface UsesOccurrence

Returns:

String

setUsesName

public void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Specified by:

setUsesName in interface UsesOccurrence

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

isPlaceholder

public boolean isPlaceholder()

Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.

Supported API: true

Specified by:

isPlaceholder in interface UsesOccurrence

Returns:

boolean

getName

public String getName()

Gets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

getName in interface Occurrence

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

setName in interface Occurrence

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getOccurrenceDataVector

public Vector getOccurrenceDataVector()

Gets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

getOccurrenceDataVector in interface Occurrence

Returns:

Vector

setOccurrenceDataVector

public void setOccurrenceDataVector(Vector a_OccurrenceDataVector)
                             throws WTPropertyVetoException

Sets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

setOccurrenceDataVector in interface Occurrence

Parameters:

a_OccurrenceDataVector -

Throws:

WTPropertyVetoException