RequirementBuilder Class

class NXOpen.Validate.RequirementBuilder

Bases: NXOpen.Builder

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

New in version NX8.5.0.

Properties

Property	Description
DataTypeOption	Returns or sets the data type option
DefinitionMethodOption	Returns or sets the definition method option
DoubleSidedMaximumValue	Returns or sets the maximum value in double sided comparison
DoubleSidedMinimumValue	Returns or sets the minimum value in double sided comparison
Formula	Returns or sets the user defined formula. Only effective when NXOpen.Validate.RequirementBuilder.DefinitionMethodOption`() is set to NXOpen.Validate.RequirementBuilderDefinitionMethodOptions.Formula.
Name	Returns or sets the name of requirement
RelationalOperatorOption	Returns or sets the relational operator option between expression label and the value in single sided comparison
RelationalOperatorOptionOnMaximumValue	Returns or sets the relational operator between expression label and maximum value in double sided comparison: [expression] < or <= maximum value.
RelationalOperatorOptionOnMinimumValue	Returns or sets the relational operator between minimum value and expression label in double sided comparison: minimum value < or <= [expression].
RequirementTolerance	Returns or sets the tolerance for point type requirement
RequirementTypeOption	Returns or sets the requirement type option
SeverityOption	Returns or sets the severity option
SingleSidedValue	Returns or sets the value for single sided comparison
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetRequirementDescription	Returns the requirement description
GetValidValues	Returns the valid values
SetRequirementDescription	Sets the requirement description
SetValidValues	Sets the valid values
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

RequirementBuilderDataTypeOptions Enumeration	This enum represents the data type of the value in requirement
RequirementBuilderDefinitionMethodOptions Enumeration	This enum represents the type of requirement definition method
RequirementBuilderRelationalOperatorOptions Enumeration	This enum represents the relational operator for comparing values
RequirementBuilderRequirementTypeOptions Enumeration	This enum represents the type of requirement
RequirementBuilderSeverityOptions Enumeration	This enum represents the severity level when a requirement is not satisfied

Property Detail

DataTypeOption

RequirementBuilder.DataTypeOption

Returns or sets the data type option

-------------------------------------

Getter Method

Signature DataTypeOption

Returns: Return type:NXOpen.Validate.RequirementBuilderDataTypeOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DataTypeOption

Parameters:dataTypeOption (NXOpen.Validate.RequirementBuilderDataTypeOptions) –

New in version NX8.5.0.

License requirements: None.

DefinitionMethodOption

RequirementBuilder.DefinitionMethodOption

Returns or sets the definition method option

-------------------------------------

Getter Method

Signature DefinitionMethodOption

Returns: Return type:NXOpen.Validate.RequirementBuilderDefinitionMethodOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefinitionMethodOption

Parameters:definitionMethodOption (NXOpen.Validate.RequirementBuilderDefinitionMethodOptions) –

New in version NX8.5.0.

License requirements: None.

DoubleSidedMaximumValue

RequirementBuilder.DoubleSidedMaximumValue

Returns or sets the maximum value in double sided comparison

-------------------------------------

Getter Method

Signature DoubleSidedMaximumValue

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DoubleSidedMaximumValue

Parameters:doubleSidedMaximumValue (str) –

New in version NX8.5.0.

License requirements: None.

DoubleSidedMinimumValue

RequirementBuilder.DoubleSidedMinimumValue

Returns or sets the minimum value in double sided comparison

-------------------------------------

Getter Method

Signature DoubleSidedMinimumValue

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DoubleSidedMinimumValue

Parameters:doubleSidedMinimumValue (str) –

New in version NX8.5.0.

License requirements: None.

Formula

RequirementBuilder.Formula

Returns or sets the user defined formula. Only effective when NXOpen.Validate.RequirementBuilder.DefinitionMethodOption`() is set to NXOpen.Validate.RequirementBuilderDefinitionMethodOptions.Formula.

-------------------------------------

Getter Method

Signature Formula

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Formula

Parameters:formula (str) –

New in version NX8.5.0.

License requirements: None.

Name

RequirementBuilder.Name

Returns or sets the name of requirement

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.5.0.

License requirements: None.

RelationalOperatorOption

RequirementBuilder.RelationalOperatorOption

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

-------------------------------------

Getter Method

Signature RelationalOperatorOption

Returns: Return type:NXOpen.Validate.RequirementBuilderRelationalOperatorOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelationalOperatorOption

Parameters:relationalOperatorOption (NXOpen.Validate.RequirementBuilderRelationalOperatorOptions) –

New in version NX8.5.0.

License requirements: None.

RelationalOperatorOptionOnMaximumValue

RequirementBuilder.RelationalOperatorOptionOnMaximumValue

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.

-------------------------------------

Getter Method

Signature RelationalOperatorOptionOnMaximumValue

Returns: Return type:NXOpen.Validate.RequirementBuilderRelationalOperatorOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelationalOperatorOptionOnMaximumValue

Parameters:relationalOperatorOnMaximumValue (NXOpen.Validate.RequirementBuilderRelationalOperatorOptions) –

New in version NX8.5.0.

License requirements: None.

RelationalOperatorOptionOnMinimumValue

RequirementBuilder.RelationalOperatorOptionOnMinimumValue

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.

-------------------------------------

Getter Method

Signature RelationalOperatorOptionOnMinimumValue

Returns: Return type:NXOpen.Validate.RequirementBuilderRelationalOperatorOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RelationalOperatorOptionOnMinimumValue

Parameters:relationalOperatorOnMinimumValue (NXOpen.Validate.RequirementBuilderRelationalOperatorOptions) –

New in version NX8.5.0.

License requirements: None.

RequirementTolerance

RequirementBuilder.RequirementTolerance

Returns or sets the tolerance for point type requirement

-------------------------------------

Getter Method

Signature RequirementTolerance

Returns: Return type:float

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RequirementTolerance

Parameters:requirementTolerance (float) – tolerance value to be set on requirement

New in version NX12.0.0.

License requirements: None.

RequirementTypeOption

RequirementBuilder.RequirementTypeOption

Returns or sets the requirement type option

-------------------------------------

Getter Method

Signature RequirementTypeOption

Returns: Return type:NXOpen.Validate.RequirementBuilderRequirementTypeOptions

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RequirementTypeOption

Parameters:requirementTypeOption (NXOpen.Validate.RequirementBuilderRequirementTypeOptions) – type to set on requirement

New in version NX12.0.0.

License requirements: None.

SeverityOption

RequirementBuilder.SeverityOption

Returns or sets the severity option

-------------------------------------

Getter Method

Signature SeverityOption

Returns: Return type:NXOpen.Validate.RequirementBuilderSeverityOptions

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SeverityOption

Parameters:severityOption (NXOpen.Validate.RequirementBuilderSeverityOptions) –

New in version NX8.5.0.

License requirements: None.

SingleSidedValue

RequirementBuilder.SingleSidedValue

Returns or sets the value for single sided comparison

-------------------------------------

Getter Method

Signature SingleSidedValue

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SingleSidedValue

Parameters:singleSidedValue (str) –

New in version NX8.5.0.

License requirements: None.

Method Detail

GetRequirementDescription

RequirementBuilder.GetRequirementDescription

Returns the requirement description

Signature GetRequirementDescription()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetValidValues

RequirementBuilder.GetValidValues

Returns the valid values

Signature GetValidValues()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: None.

SetRequirementDescription

RequirementBuilder.SetRequirementDescription

Sets the requirement description

Signature SetRequirementDescription(requirementDescription)

Parameters:requirementDescription (list of str) –

New in version NX8.5.0.

License requirements: None.

SetValidValues

RequirementBuilder.SetValidValues

Sets the valid values

Signature SetValidValues(validValues)

Parameters:validValues (list of str) –

New in version NX8.5.0.

License requirements: None.

Validate

RequirementBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.