wt.epm.supportingdata.cadds5data
Class EPMCaddsDisplayState

java.lang.Object
  wt.epm.supportingdata.cadds5data.EPMCaddsDisplayState

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class EPMCaddsDisplayState

extends Object

implements ObjectMappable, Externalizable

A cadds display state describes how to graphically display in CADDS5 one particular occurrence of component in a mechanical assembly.

Use the newEPMCaddsDisplayState static factory method(s), not the EPMCaddsDisplayState 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private int	color
static String	COLOR Label for the attribute; The color attribute governs what color to graphically display an occurrence in.
static String	DISPLAY_PARAMETERS Label for the attribute; The display parameters flag controls whether or not to show the parametric dimensions along with the model goemetry.
private boolean	displayParameters
static long	EXTERNALIZATION_VERSION_UID
private boolean	highlighted
static String	HIGHLIGHTED Label for the attribute; The highlighted flag controls whether or not to highlight an occurrence's graphical image.
static String	LAYER_MASK Label for the attribute; In a CADDS5 part, geometric entities reside on layers.
static String	LAYER_OFFSET Label for the attribute; In a CADDS5 part, geometric entities reside on layers.
private int[]	layerMask
private short	layerOffset
static String	OCCURRENCE_ID Label for the attribute; The occurrenceId identifies the particular component member of the mechanical assembly.
private int	occurrenceId
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private boolean	viewed
static String	VIEWED Label for the attribute; The viewed flag controls whether or not an occurrence is graphically displayed in a graphical viewer.

Constructor Summary

EPMCaddsDisplayState()

Method Summary

ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
int	getColor() Gets the value of the attribute: COLOR.
String	getConceptualClassname() Deprecated.
int[]	getLayerMask() Gets the value of the attribute: LAYER_MASK.
short	getLayerOffset() Gets the value of the attribute: LAYER_OFFSET.
int	getOccurrenceId() Gets the value of the attribute: OCCURRENCE_ID.
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isDisplayParameters() Gets the value of the attribute: DISPLAY_PARAMETERS.
boolean	isHighlighted() Gets the value of the attribute: HIGHLIGHTED.
boolean	isViewed() Gets the value of the attribute: VIEWED.
static EPMCaddsDisplayState	newEPMCaddsDisplayState() Default factory for the class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EPMCaddsDisplayState thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setColor(int a_Color) Sets the value of the attribute: COLOR.
void	setDisplayParameters(boolean a_DisplayParameters) Sets the value of the attribute: DISPLAY_PARAMETERS.
void	setHighlighted(boolean a_Highlighted) Sets the value of the attribute: HIGHLIGHTED.
void	setLayerMask(int[] a_LayerMask) Sets the value of the attribute: LAYER_MASK.
void	setLayerOffset(short a_LayerOffset) Sets the value of the attribute: LAYER_OFFSET.
void	setOccurrenceId(int a_OccurrenceId) Sets the value of the attribute: OCCURRENCE_ID.
void	setViewed(boolean a_Viewed) Sets the value of the attribute: VIEWED.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VIEWED

public static final String VIEWED

Label for the attribute; The viewed flag controls whether or not an occurrence is graphically displayed in a graphical viewer.

Supported API: false

See Also:

Constant Field Values

viewed

private boolean viewed

HIGHLIGHTED

public static final String HIGHLIGHTED

Label for the attribute; The highlighted flag controls whether or not to highlight an occurrence's graphical image.

Supported API: false

See Also:

Constant Field Values

highlighted

private boolean highlighted

COLOR

public static final String COLOR

Label for the attribute; The color attribute governs what color to graphically display an occurrence in.

Supported API: false

See Also:

Constant Field Values

color

private int color

LAYER_OFFSET

public static final String LAYER_OFFSET

Label for the attribute; In a CADDS5 part, geometric entities reside on layers. When you display a part in the context of another part, CADDS5 can offset the layer on which an entity is displayed by a given value. The layer offset attribute holds that offset value.

Supported API: false

See Also:

Constant Field Values

layerOffset

private short layerOffset

LAYER_MASK

public static final String LAYER_MASK

Label for the attribute; In a CADDS5 part, geometric entities reside on layers. A layermask acts as filter. It allows you to display only those entities in your part that resides on specific layers.

Supported API: false

See Also:

Constant Field Values

layerMask

private int[] layerMask

DISPLAY_PARAMETERS

public static final String DISPLAY_PARAMETERS

Label for the attribute; The display parameters flag controls whether or not to show the parametric dimensions along with the model goemetry.

Supported API: false

See Also:

Constant Field Values

displayParameters

private boolean displayParameters

OCCURRENCE_ID

public static final String OCCURRENCE_ID

Label for the attribute; The occurrenceId identifies the particular component member of the mechanical assembly.

Supported API: false

See Also:

Constant Field Values

occurrenceId

private int occurrenceId

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EPMCaddsDisplayState

public EPMCaddsDisplayState()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMCaddsDisplayState thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

isViewed

public boolean isViewed()

Gets the value of the attribute: VIEWED. The viewed flag controls whether or not an occurrence is graphically displayed in a graphical viewer.

Supported API: false

Returns:

boolean

setViewed

public void setViewed(boolean a_Viewed)
               throws WTPropertyVetoException

Sets the value of the attribute: VIEWED. The viewed flag controls whether or not an occurrence is graphically displayed in a graphical viewer.

Supported API: false

Parameters:

a_Viewed -

Throws:

WTPropertyVetoException

isHighlighted

public boolean isHighlighted()

Gets the value of the attribute: HIGHLIGHTED. The highlighted flag controls whether or not to highlight an occurrence's graphical image.

Supported API: false

Returns:

boolean

setHighlighted

public void setHighlighted(boolean a_Highlighted)
                    throws WTPropertyVetoException

Sets the value of the attribute: HIGHLIGHTED. The highlighted flag controls whether or not to highlight an occurrence's graphical image.

Supported API: false

Parameters:

a_Highlighted -

Throws:

WTPropertyVetoException

getColor

public int getColor()

Gets the value of the attribute: COLOR. The color attribute governs what color to graphically display an occurrence in.

Supported API: false

Returns:

int

setColor

public void setColor(int a_Color)
              throws WTPropertyVetoException

Sets the value of the attribute: COLOR. The color attribute governs what color to graphically display an occurrence in.

Supported API: false

Parameters:

a_Color -

Throws:

WTPropertyVetoException

getLayerOffset

public short getLayerOffset()

Gets the value of the attribute: LAYER_OFFSET. In a CADDS5 part, geometric entities reside on layers. When you display a part in the context of another part, CADDS5 can offset the layer on which an entity is displayed by a given value. The layer offset attribute holds that offset value.

Supported API: false

Returns:

short

setLayerOffset

public void setLayerOffset(short a_LayerOffset)
                    throws WTPropertyVetoException

Sets the value of the attribute: LAYER_OFFSET. In a CADDS5 part, geometric entities reside on layers. When you display a part in the context of another part, CADDS5 can offset the layer on which an entity is displayed by a given value. The layer offset attribute holds that offset value.

Supported API: false

Parameters:

a_LayerOffset -

Throws:

WTPropertyVetoException

getLayerMask

public int[] getLayerMask()

Gets the value of the attribute: LAYER_MASK. In a CADDS5 part, geometric entities reside on layers. A layermask acts as filter. It allows you to display only those entities in your part that resides on specific layers.

Supported API: false

Returns:

int[]

setLayerMask

public void setLayerMask(int[] a_LayerMask)
                  throws WTPropertyVetoException

Sets the value of the attribute: LAYER_MASK. In a CADDS5 part, geometric entities reside on layers. A layermask acts as filter. It allows you to display only those entities in your part that resides on specific layers.

Supported API: false

Parameters:

a_LayerMask -

Throws:

WTPropertyVetoException

isDisplayParameters

public boolean isDisplayParameters()

Gets the value of the attribute: DISPLAY_PARAMETERS. The display parameters flag controls whether or not to show the parametric dimensions along with the model goemetry.

Supported API: false

Returns:

boolean

setDisplayParameters

public void setDisplayParameters(boolean a_DisplayParameters)
                          throws WTPropertyVetoException

Sets the value of the attribute: DISPLAY_PARAMETERS. The display parameters flag controls whether or not to show the parametric dimensions along with the model goemetry.

Supported API: false

Parameters:

a_DisplayParameters -

Throws:

WTPropertyVetoException

getOccurrenceId

public int getOccurrenceId()

Gets the value of the attribute: OCCURRENCE_ID. The occurrenceId identifies the particular component member of the mechanical assembly.

Supported API: false

Returns:

int

setOccurrenceId

public void setOccurrenceId(int a_OccurrenceId)
                     throws WTPropertyVetoException

Sets the value of the attribute: OCCURRENCE_ID. The occurrenceId identifies the particular component member of the mechanical assembly.

Supported API: false

Parameters:

a_OccurrenceId -

Throws:

WTPropertyVetoException

newEPMCaddsDisplayState

public static EPMCaddsDisplayState newEPMCaddsDisplayState()
                                                    throws WTException

Default factory for the class.

Supported API: false

Returns:

EPMCaddsDisplayState

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: false

Throws:

WTException