nxopen

Interface Expression

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

public interface Expression
extends NXObject

Represents an expression.
To create a new instance of this class, use ExpressionCollection.createWithUnits(java.lang.String, nxopen.Unit)

Created in NX3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Expression.InterpartExpressionNamesData This class holds the data returned from getInterpartExpressionNames()
static class	Expression.UnitsOption Indicates the units to use when getting an expression's value.

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue() Returns the boolean value of the expression.
String	description() Returns the description of the expression.
void	editComment(String newComment) Changes the comment.
String	equation() Returns the equation of the expression in the form: name = right_hand_side.
String	getDescriptor() Returns the descriptor for the expression, or null if there is no descriptor.
Expression.InterpartExpressionNamesData	getInterpartExpressionNames() The source part name and source expression name of the interpart expression License requirements: None.
Object	getListValue() Returns the list value of the expression.
Feature	getOwningFeature() Returns the feature that created the supplied expression.
Feature	getOwningRpoFeature() Returns the feature whose rpo_transform created the supplied positioning dimension expression.
Expression[]	getReferencingExpressions() Returns all the referencing expressions of the expression License requirements: None.
Feature[]	getUsingFeatures() Returns an array of the features that use the supplied expression.
double	getValueUsingUnits(Expression.UnitsOption unitsOption) Get the value of the expression, in either base units or the expression's units.
int	integerValue() Returns the integer value of the expression.
boolean	isGeometricExpression() Returns whether the expression is a geometric expression.
boolean	isInterpartExpression() Returns whether the expression is an interpart expression.
boolean	isMeasurementExpression() Returns whether the expression is owned by a measurement.
boolean	isNoEdit() Returns whether the expression is edit locked.
boolean	isNoUpdate() Returns whether the expression is update locked.
boolean	isRightHandSideLockedFromEdit() Returns whether the expression formula is locked from user edit.
boolean	isUserLocked() Returns whether the expression is user locked.
Point3d	pointValue() Returns the point value of the expression.
String	rightHandSide() Returns the right hand side of the expression.
void	setNoEdit(boolean isNoEdit) License requirements: None.
void	setNoUpdate(boolean isNoUpdate) License requirements: None.
void	setRightHandSide(String rightHandSide) License requirements: None.
void	setUnits(Unit unitType) License requirements: None.
void	setUserLocked(boolean isLocked) License requirements: None.
void	setValue(double expressionValue) License requirements: None.
String	stringValue() Returns the string value of the expression.
String	type() Returns the type of the expression.
Unit	units() Returns the units for the expression.
double	value() Returns the value of the expression in base units.
Vector3d	vectorValue() Returns the vector value of the expression.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

equation

String equation()
         throws NXException,
                RemoteException

Returns the equation of the expression in the form: name = right_hand_side.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

rightHandSide

String rightHandSide()
              throws NXException,
                     RemoteException

Returns the right hand side of the expression.
When setting the property, changes are not applied to the system until Update.doUpdate(int) is called

License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setRightHandSide

void setRightHandSide(String rightHandSide)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX3.0.0

Parameters:

rightHandSide -

Throws:

NXException

RemoteException

value

double value()
      throws NXException,
             RemoteException

Returns the value of the expression in base units. This method must only be used on number expressions. When setting the value, any formula in the expression is replaced by a numeric value, even if the value is the same as the value that the formula evaluates to.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setValue

void setValue(double expressionValue)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX6.0.1

Parameters:

expressionValue -

Throws:

NXException

RemoteException

getValueUsingUnits

double getValueUsingUnits(Expression.UnitsOption unitsOption)
                   throws NXException,
                          RemoteException

Get the value of the expression, in either base units or the expression's units. This method must only be used on number expressions.
License requirements: None.

Created in NX4.0.0

Parameters:

unitsOption - use base units or expression units

Throws:

NXException

RemoteException

stringValue

String stringValue()
            throws NXException,
                   RemoteException

Returns the string value of the expression. This must only be used on string expressions.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

booleanValue

boolean booleanValue()
              throws NXException,
                     RemoteException

Returns the boolean value of the expression. This must only be used on boolean expressions.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

integerValue

int integerValue()
          throws NXException,
                 RemoteException

Returns the integer value of the expression. This must only be used on integer expressions.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

pointValue

Point3d pointValue()
            throws NXException,
                   RemoteException

Returns the point value of the expression. This must only be used on point expressions.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

vectorValue

Vector3d vectorValue()
              throws NXException,
                     RemoteException

Returns the vector value of the expression. This must only be used on vector expressions.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

getListValue

Object getListValue()
             throws NXException,
                    RemoteException

Returns the list value of the expression. This must only be used on list expressions.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

isUserLocked

boolean isUserLocked()
              throws NXException,
                     RemoteException

Returns whether the expression is user locked. If this property is false, then the expression can be over-ridden from another part. (This is the default state for newly created expressions.) If this property is true, you are not allowed to over-ride it. This corresponds to the interactive option RMB Toggle Interpart Override Lock.
Note that if an expression is currently over-ridden, you cannot set its lock property. In this instance, an exception will be thrown.

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setUserLocked

void setUserLocked(boolean isLocked)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX4.0.0

Parameters:

isLocked -

Throws:

NXException

RemoteException

editComment

void editComment(String newComment)
          throws NXException,
                 RemoteException

Changes the comment.
License requirements: None.

Created in NX4.0.0

Parameters:

newComment - comment

Throws:

NXException

RemoteException

isGeometricExpression

boolean isGeometricExpression()
                       throws NXException,
                              RemoteException

Returns whether the expression is a geometric expression.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

getUsingFeatures

Feature[] getUsingFeatures()
                    throws NXException,
                           RemoteException

Returns an array of the features that use the supplied expression.
License requirements: None.

Created in NX4.0.0

Returns:

array of features, or empty array

Throws:

NXException

RemoteException

getOwningFeature

Feature getOwningFeature()
                  throws NXException,
                         RemoteException

Returns the feature that created the supplied expression.
This is the feature that created it during feature creation. For example, the expression "p0 = x" is owned by feature "BLOCK(0)".

This works with both normal expressions and expressions created by the geometric expression feature.

License requirements: None.

Created in NX4.0.0

Returns:

owning feature or null

Throws:

NXException

RemoteException

getOwningRpoFeature

Feature getOwningRpoFeature()
                     throws NXException,
                            RemoteException

Returns the feature whose rpo_transform created the supplied positioning dimension expression.
This is the feature that created it during positioning the feature. For example, the expression "p0 = x" is owned by the Transform of feature "Boss(2)".

This works with expressions created by the feature with rpo.

License requirements: None.

Created in NX7.5.0

Returns:

owning rpo feature or null

Throws:

NXException

RemoteException

getDescriptor

String getDescriptor()
              throws NXException,
                     RemoteException

Returns the descriptor for the expression, or null if there is no descriptor. Currently, only feature expressions have descriptors.
License requirements: None.

Created in NX4.0.0

Returns:

Expression descriptor.

Throws:

NXException

RemoteException

units

Unit units()
    throws NXException,
           RemoteException

Returns the units for the expression. This must only be used on number expressions.
License requirements: None.

Created in NX4.0.0

Returns:

null if the expression has no units

Throws:

NXException

RemoteException

setUnits

void setUnits(Unit unitType)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

unitType -

Throws:

NXException

RemoteException

type

String type()
     throws NXException,
            RemoteException

Returns the type of the expression.
License requirements: None.

Created in NX5.0.0

Returns:

a text string for the expression type

Throws:

NXException

RemoteException

isMeasurementExpression

boolean isMeasurementExpression()
                         throws NXException,
                                RemoteException

Returns whether the expression is owned by a measurement.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

description

String description()
            throws NXException,
                   RemoteException

Returns the description of the expression. This can be used to get the "A"::x formatted name for interpart expressions.
License requirements: None.

Created in NX5.0.2

Throws:

NXException

RemoteException

getReferencingExpressions

Expression[] getReferencingExpressions()
                                throws NXException,
                                       RemoteException

Returns all the referencing expressions of the expression
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

isNoEdit

boolean isNoEdit()
          throws NXException,
                 RemoteException

Returns whether the expression is edit locked. If this property is false, then the expression can be edited. (This is the default state for newly created expressions.) If this property is true, then the expression cannot be edited. This corresponds to the interactive option RMB Lock Formula/RMB Unlock Formula.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setNoEdit

void setNoEdit(boolean isNoEdit)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

isNoEdit -

Throws:

NXException

RemoteException

isNoUpdate

boolean isNoUpdate()
            throws NXException,
                   RemoteException

Returns whether the expression is update locked. If this property is false, then the expression can update. (This is the default state for newly created expressions.) If this property is true, then the expression cannot update.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setNoUpdate

void setNoUpdate(boolean isNoUpdate)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

isNoUpdate -

Throws:

NXException

RemoteException

isInterpartExpression

boolean isInterpartExpression()
                       throws NXException,
                              RemoteException

Returns whether the expression is an interpart expression.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

getInterpartExpressionNames

Expression.InterpartExpressionNamesData getInterpartExpressionNames()
                                                             throws NXException,
                                                                    RemoteException

The source part name and source expression name of the interpart expression
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

isRightHandSideLockedFromEdit

boolean isRightHandSideLockedFromEdit()
                               throws NXException,
                                      RemoteException

Returns whether the expression formula is locked from user edit. This can be for a variety of reasons. It can be locked by user, locked by internal sub system, part of a measure or geometric expression, or locked because of interpart relations. This corresponds to the set of expressions governed by the show locked formula expression toggle on the expression dialog.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException