NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Validate.RequirementBuilder Class Reference

Represents a NXOpen.Validate.Requirement builder More...

Inheritance diagram for NXOpen.Validate.RequirementBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DataTypeOptions {
  Number, String, Boolean, Integer,
  Point
}
 This enum represents the data type of the value in requirement More...
 
enum  DefinitionMethodOptions { SingleSidedComparison, DoubleSidedComparison, SetOfValues, Formula }
 This enum represents the type of requirement definition method More...
 
enum  RelationalOperatorOptions {
  Equal, NotEqual, LessThan, LessThanOrEqual,
  GreaterThan, GreaterThanOrEqual
}
 This enum represents the relational operator for comparing values More...
 
enum  RequirementTypeOptions { ValidationLimit, DesignLimit }
 This enum represents the type of requirement More...
 
enum  SeverityOptions { Error, Warning, Information }
 This enum represents the severity level when a requirement is not satisfied More...
 

Public Member Functions

unsafe string[] GetRequirementDescription ()
 Returns the requirement description More...
 
unsafe string[] GetValidValues ()
 Returns the valid values More...
 
unsafe void SetRequirementDescription (string[] requirementDescription)
 Sets the requirement description More...
 
unsafe void SetValidValues (string[] validValues)
 Sets the valid values More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Validate.RequirementBuilder.DataTypeOptions 
DataTypeOption [get, set]
 Returns or sets the data type option More...
 
unsafe
NXOpen.Validate.RequirementBuilder.DefinitionMethodOptions 
DefinitionMethodOption [get, set]
 Returns or sets the definition method option More...
 
unsafe string DoubleSidedMaximumValue [get, set]
 Returns or sets the maximum value in double sided comparison More...
 
unsafe string DoubleSidedMinimumValue [get, set]
 Returns or sets the minimum value in double sided comparison More...
 
unsafe string Formula [get, set]
 Returns or sets the user defined formula. More...
 
unsafe string Name [get, set]
 Returns or sets the name of requirement More...
 
unsafe
NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions 
RelationalOperatorOption [get, set]
 Returns or sets the relational operator option between expression label and the value in single sided comparison More...
 
unsafe
NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions 
RelationalOperatorOptionOnMaximumValue [get, set]
 Returns or sets the relational operator between expression label and maximum value in double sided comparison: [expression] < or <= maximum value. More...
 
unsafe
NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions 
RelationalOperatorOptionOnMinimumValue [get, set]
 Returns or sets the relational operator between minimum value and expression label in double sided comparison: minimum value < or <= [expression]. More...
 
unsafe double RequirementTolerance [get, set]
 Returns or sets the tolerance for point type requirement More...
 
unsafe
NXOpen.Validate.RequirementBuilder.RequirementTypeOptions 
RequirementTypeOption [get, set]
 Returns or sets the requirement type option More...
 
unsafe
NXOpen.Validate.RequirementBuilder.SeverityOptions 
SeverityOption [get, set]
 Returns or sets the severity option More...
 
unsafe string SingleSidedValue [get, set]
 Returns or sets the value for single sided comparison More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Validate.Requirement builder

To create a new instance of this class, use NXOpen.Validate.RequirementCollection.CreateRequirementBuilder

Default values.

Property Value

DataTypeOption

Number

DefinitionMethodOption

SingleSidedComparison

RelationalOperatorOption

Equal

RelationalOperatorOptionOnMaximumValue

LessThan

RelationalOperatorOptionOnMinimumValue

LessThan

SeverityOption

Error

Created in NX8.5.0

Member Enumeration Documentation

This enum represents the data type of the value in requirement

Enumerator
Number 
String 
Boolean 
Integer 
Point 

This enum represents the type of requirement definition method

Enumerator
SingleSidedComparison 
DoubleSidedComparison 
SetOfValues 
Formula 

This enum represents the relational operator for comparing values

Enumerator
Equal 
NotEqual 
LessThan 
LessThanOrEqual 
GreaterThan 
GreaterThanOrEqual 

This enum represents the type of requirement

Enumerator
ValidationLimit 
DesignLimit 

This enum represents the severity level when a requirement is not satisfied

Enumerator
Error 
Warning 
Information 

Member Function Documentation

unsafe string [] NXOpen.Validate.RequirementBuilder.GetRequirementDescription ( )
inline

Returns the requirement description

Created in NX8.5.0

License requirements: None.

Returns
unsafe string [] NXOpen.Validate.RequirementBuilder.GetValidValues ( )
inline

Returns the valid values

Created in NX8.5.0

License requirements: None.

Returns
unsafe void NXOpen.Validate.RequirementBuilder.SetRequirementDescription ( string[]  requirementDescription)
inline

Sets the requirement description

Created in NX8.5.0

License requirements: None.

Parameters
requirementDescription
unsafe void NXOpen.Validate.RequirementBuilder.SetValidValues ( string[]  validValues)
inline

Sets the valid values

Created in NX8.5.0

License requirements: None.

Parameters
validValues

Property Documentation

unsafe NXOpen.Validate.RequirementBuilder.DataTypeOptions NXOpen.Validate.RequirementBuilder.DataTypeOption
getset

Returns or sets the data type option

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.DefinitionMethodOptions NXOpen.Validate.RequirementBuilder.DefinitionMethodOption
getset

Returns or sets the definition method option

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.RequirementBuilder.DoubleSidedMaximumValue
getset

Returns or sets the maximum value in double sided comparison

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.RequirementBuilder.DoubleSidedMinimumValue
getset

Returns or sets the minimum value in double sided comparison

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.RequirementBuilder.Formula
getset

Returns or sets the user defined formula.

Only effective when NXOpen.Validate.RequirementBuilder.DefinitionMethodOption is set to NXOpen.Validate.RequirementBuilder.DefinitionMethodOptions.Formula .

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.RequirementBuilder.Name
getset

Returns or sets the name of requirement

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions NXOpen.Validate.RequirementBuilder.RelationalOperatorOption
getset

Returns or sets the relational operator option between expression label and the value in single sided comparison

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions NXOpen.Validate.RequirementBuilder.RelationalOperatorOptionOnMaximumValue
getset

Returns or sets the relational operator between expression label and maximum value in double sided comparison: [expression] < or <= maximum value.

The valid operator is either LessThan or LessThanOrEqual.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.RelationalOperatorOptions NXOpen.Validate.RequirementBuilder.RelationalOperatorOptionOnMinimumValue
getset

Returns or sets the relational operator between minimum value and expression label in double sided comparison: minimum value < or <= [expression].

The valid operator is either LessThan or LessThanOrEqual.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Validate.RequirementBuilder.RequirementTolerance
getset

Returns or sets the tolerance for point type requirement

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.RequirementTypeOptions NXOpen.Validate.RequirementBuilder.RequirementTypeOption
getset

Returns or sets the requirement type option

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.RequirementBuilder.SeverityOptions NXOpen.Validate.RequirementBuilder.SeverityOption
getset

Returns or sets the severity option

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.RequirementBuilder.SingleSidedValue
getset

Returns or sets the value for single sided comparison

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.