NXOpen .NET Reference
12.0.0
|
Represents an expression. More...
Public Types | |
enum | UnitsOption { Base, Expression } |
Indicates the units to use when getting an expression's value. More... | |
Public Types inherited from NXOpen.NXObject | |
enum | AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 } |
Specifies attribute type. More... | |
enum | DateAndTimeFormat { Numeric, Textual } |
Specifies the format of the date and time attribute. More... | |
Public Member Functions | |
unsafe double | GetValueUsingUnits (NXOpen.Expression.UnitsOption unitsOption) |
Get the value of the expression, in either base units or the expression's units. More... | |
unsafe Object | GetListValue () |
Returns the list value of the expression. More... | |
unsafe void | EditComment (string newComment) |
Changes the comment. More... | |
unsafe NXOpen.Features.Feature[] | GetUsingFeatures () |
Returns an array of the features that use the supplied expression. More... | |
unsafe NXOpen.Features.Feature | GetOwningFeature () |
Returns the feature that created the supplied expression. More... | |
unsafe NXOpen.Features.Feature | GetOwningRpoFeature () |
Returns the feature whose rpo_transform created the supplied positioning dimension expression. More... | |
unsafe string | GetDescriptor () |
Returns the descriptor for the expression, or a null reference (Nothing in Visual Basic) if there is no descriptor. More... | |
unsafe NXOpen.Expression[] | GetReferencingExpressions () |
Returns all the referencing expressions of the expression More... | |
unsafe void | GetInterpartExpressionNames (out string partName, out string expName) |
The source part name and source expression name of the interpart expression More... | |
Public Member Functions inherited from NXOpen.NXObject | |
unsafe void | SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option) |
Creates or modifies an attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option) |
Creates or modifies a boolean attribute with the option to update or not. More... | |
unsafe NXOpen.AttributeIterator | CreateAttributeIterator () |
Create an attribute iterator More... | |
unsafe bool | HasUserAttribute (NXOpen.AttributeIterator iterator) |
Determines if an attribute exists on the object, that satisfies the given iterator More... | |
unsafe bool | HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type) |
Gets the count of set attributes on the object, if any, of the given type. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
Gets the count of attributes on the object, if any, of the given type. More... | |
unsafe int | GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
unsafe bool | GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info) |
Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More... | |
unsafe NXOpen.NXObject.AttributeInformation | GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
unsafe bool | GetBooleanUserAttribute (string title, int index) |
Gets a boolean attribute by Title and array Index. More... | |
unsafe int | GetIntegerUserAttribute (string title, int index) |
Gets an integer attribute by Title and array Index. More... | |
unsafe double | GetRealUserAttribute (string title, int index) |
Gets a real attribute by Title and array Index. More... | |
unsafe string | GetStringUserAttribute (string title, int index) |
Gets a string attribute by Title and array Index. More... | |
unsafe string | GetTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.ComputationalTime | GetComputationalTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (NXOpen.AttributeIterator iterator) |
Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes () |
Gets all the attributes that have been set on the given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset) |
Gets all the attributes of the given object. More... | |
unsafe string | GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
unsafe void | DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option) |
Deletes the attributes on the object, if any, that satisfy the given iterator More... | |
unsafe void | DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option) |
Deletes the first attribute encountered with the given Type, Title. More... | |
unsafe void | DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes the attributes encountered with the given Type with option to update or not. More... | |
unsafe void | SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock) |
Lock or unlock the given attribute. More... | |
unsafe bool | GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type) |
Determine the lock of the given attribute. More... | |
unsafe NXOpen.NXObject[] | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. More... | |
unsafe void | SetPdmReferenceAttribute (string attributeTitle, string attributeValue) |
Sets the value of PDM Reference attribute on the object. More... | |
unsafe string | GetPdmReferenceAttributeValue (string attributeTitle) |
Gets the value of PDM Reference attribute for given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes of the given object. More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type) |
Deletes all attributes of a specific type. More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes all attributes of a specific type with the option to update or not. More... | |
unsafe void | SetAttribute (string title, int value) |
Creates or modifies an integer attribute. More... | |
unsafe void | SetAttribute (string title, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, double value) |
Creates or modifies a real attribute. More... | |
unsafe void | SetAttribute (string title, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, string value) |
Creates or modifies a string attribute. More... | |
unsafe void | SetAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title) |
Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
unsafe void | SetAttribute (string title, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetTimeAttribute (string title, string value) |
Creates or modifies a time attribute. More... | |
unsafe void | SetTimeAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe int | GetIntegerAttribute (string title) |
Gets an integer attribute by title. More... | |
unsafe double | GetRealAttribute (string title) |
Gets a real attribute by title. More... | |
unsafe string | GetStringAttribute (string title) |
Gets a string attribute value by title. More... | |
unsafe string | GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title) |
Gets a time attribute by title. More... | |
unsafe string | GetReferenceAttribute (string title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title) |
Deletes an attribute by type and title. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option) |
Deletes an attribute by type and title with the option to update or not. More... | |
unsafe void | SetReferenceAttribute (string title, string value) |
Creates or modifies a string attribute which uses a reference string. More... | |
unsafe void | SetReferenceAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type) |
Gets all the attribute titles of a specific type. More... | |
unsafe string[] | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. More... | |
unsafe NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
unsafe void | Print () |
Prints a representation of this object to the system log file. More... | |
unsafe void | SetName (string name) |
Sets the custom name of the object. More... | |
Properties | |
unsafe bool | BooleanValue [get] |
Returns the boolean value of the expression. More... | |
unsafe string | Description [get] |
Returns the description of the expression. More... | |
unsafe string | Equation [get] |
Returns the equation of the expression in the form: name = right_hand_side. More... | |
unsafe int | IntegerValue [get] |
Returns the integer value of the expression. More... | |
unsafe bool | IsGeometricExpression [get] |
Returns whether the expression is a geometric expression. More... | |
unsafe bool | IsInterpartExpression [get] |
Returns whether the expression is an interpart expression. More... | |
unsafe bool | IsMeasurementExpression [get] |
Returns whether the expression is owned by a measurement. More... | |
unsafe bool | IsNoEdit [get, set] |
Returns or sets whether the expression is edit locked. More... | |
unsafe bool | IsNoUpdate [get, set] |
Returns or sets whether the expression is update locked. More... | |
unsafe bool | IsRightHandSideLockedFromEdit [get] |
Returns whether the expression formula is locked from user edit. More... | |
unsafe bool | IsUserLocked [get, set] |
Returns or sets whether the expression is user locked. More... | |
unsafe NXOpen.Point3d | PointValue [get] |
Returns the point value of the expression. More... | |
unsafe string | RightHandSide [get, set] |
Returns or sets the right hand side of the expression. More... | |
unsafe string | StringValue [get] |
Returns the string value of the expression. More... | |
unsafe string | Type [get] |
Returns the type of the expression. More... | |
unsafe NXOpen.Unit | Units [get, set] |
Returns or sets the units for the expression. More... | |
unsafe double | Value [get, set] |
Returns or sets the value of the expression in base units. More... | |
unsafe NXOpen.Vector3d | VectorValue [get] |
Returns the vector value of the expression. More... | |
Properties inherited from NXOpen.NXObject | |
unsafe bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
unsafe string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
unsafe string | Name [get] |
Returns the custom name of the object. More... | |
unsafe NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
unsafe NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
unsafe NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. More... | |
Properties inherited from NXOpen.INXObject | |
bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
string | Name [get] |
Returns the custom name of the object. More... | |
NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. More... | |
Represents an expression.
To create a new instance of this class, use NXOpen.ExpressionCollection.CreateWithUnits
Created in NX3.0.0
unsafe void NXOpen.Expression.EditComment | ( | string | newComment | ) |
Changes the comment.
Created in NX4.0.0
License requirements: None.
newComment | comment |
unsafe string NXOpen.Expression.GetDescriptor | ( | ) |
Returns the descriptor for the expression, or a null reference (Nothing in Visual Basic) if there is no descriptor.
Currently, only feature expressions have descriptors.
Created in NX4.0.0
License requirements: None.
unsafe void NXOpen.Expression.GetInterpartExpressionNames | ( | out string | partName, |
out string | expName | ||
) |
The source part name and source expression name of the interpart expression
Created in NX10.0.0
License requirements: None.
partName | |
expName |
unsafe Object NXOpen.Expression.GetListValue | ( | ) |
Returns the list value of the expression.
This must only be used on list expressions.
Created in NX6.0.0
License requirements: None.
unsafe NXOpen.Features.Feature NXOpen.Expression.GetOwningFeature | ( | ) |
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.
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Features.Feature NXOpen.Expression.GetOwningRpoFeature | ( | ) |
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.
Created in NX7.5.0
License requirements: None.
unsafe NXOpen.Expression [] NXOpen.Expression.GetReferencingExpressions | ( | ) |
Returns all the referencing expressions of the expression
Created in NX8.0.0
License requirements: None.
unsafe NXOpen.Features.Feature [] NXOpen.Expression.GetUsingFeatures | ( | ) |
Returns an array of the features that use the supplied expression.
Created in NX4.0.0
License requirements: None.
unsafe double NXOpen.Expression.GetValueUsingUnits | ( | NXOpen.Expression.UnitsOption | unitsOption | ) |
Get the value of the expression, in either base units or the expression's units.
This method must only be used on number expressions.
Created in NX4.0.0
License requirements: None.
unitsOption | use base units or expression units |
|
get |
Returns the boolean value of the expression.
This must only be used on boolean expressions.
Created in NX6.0.0
License requirements: None.
|
get |
Returns the description of the expression.
This can be used to get the "A"x formatted name for interpart expressions.
Created in NX5.0.2
License requirements: None.
|
get |
Returns the equation of the expression in the form: name = right_hand_side.
Created in NX3.0.0
License requirements: None.
|
get |
Returns the integer value of the expression.
This must only be used on integer expressions.
Created in NX6.0.0
License requirements: None.
|
get |
Returns whether the expression is a geometric expression.
Created in NX4.0.0
License requirements: None.
|
get |
Returns whether the expression is an interpart expression.
Created in NX11.0.0
License requirements: None.
|
get |
Returns whether the expression is owned by a measurement.
Created in NX5.0.0
License requirements: None.
|
getset |
Returns or sets 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.
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets 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.
Created in NX10.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
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.
Created in NX11.0.0
License requirements: None.
|
getset |
Returns or sets 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.
Created in NX4.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the point value of the expression.
This must only be used on point expressions.
Created in NX6.0.0
License requirements: None.
|
getset |
Returns or sets the right hand side of the expression.
When setting the property, changes are not applied to the system until Update.DoUpdate is called
Created in NX3.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the string value of the expression.
This must only be used on string expressions.
Created in NX5.0.0
License requirements: None.
|
get |
Returns the type of the expression.
Created in NX5.0.0
License requirements: None.
|
getset |
Returns or sets the units for the expression.
This must only be used on number expressions.
Created in NX4.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets 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.
Created in NX3.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the vector value of the expression.
This must only be used on vector expressions.
Created in NX6.0.0
License requirements: None.