Represents a NXOpen::Validate::Requirement builder
To create a new instance of this class, use NXOpen::Validate::RequirementCollection::CreateRequirementBuilder
Default values. More...

Inheritance diagram for NXOpen::Validate::RequirementBuilder:

Public Types
enum	DataTypeOptions { DataTypeOptionsNumber, DataTypeOptionsString, DataTypeOptionsBoolean, DataTypeOptionsInteger, DataTypeOptionsPoint }
	This enum represents the data type of the value in requirement. More...

enum	DefinitionMethodOptions { DefinitionMethodOptionsSingleSidedComparison, DefinitionMethodOptionsDoubleSidedComparison, DefinitionMethodOptionsSetOfValues, DefinitionMethodOptionsFormula }
	This enum represents the type of requirement definition method. More...

enum	RelationalOperatorOptions { RelationalOperatorOptionsEqual, RelationalOperatorOptionsNotEqual, RelationalOperatorOptionsLessThan, RelationalOperatorOptionsLessThanOrEqual, RelationalOperatorOptionsGreaterThan, RelationalOperatorOptionsGreaterThanOrEqual }
	This enum represents the relational operator for comparing values. More...

enum	RequirementTypeOptions { RequirementTypeOptionsValidationLimit, RequirementTypeOptionsDesignLimit }
	This enum represents the type of requirement. More...

enum	SeverityOptions { SeverityOptionsError, SeverityOptionsWarning, SeverityOptionsInformation }
	This enum represents the severity level when a requirement is not satisfied. More...

Public Member Functions
NXOpen::Validate::RequirementBuilder::DataTypeOptions	DataTypeOption ()
	Returns the data type option Created in NX8.5.0. More...

NXOpen::Validate::RequirementBuilder::DefinitionMethodOptions	DefinitionMethodOption ()
	Returns the definition method option Created in NX8.5.0. More...

NXString	DoubleSidedMaximumValue ()
	Returns the maximum value in double sided comparison Created in NX8.5.0. More...

NXString	DoubleSidedMinimumValue ()
	Returns the minimum value in double sided comparison Created in NX8.5.0. More...

NXString	Formula ()
	Returns. More...

std::vector< NXString >	GetRequirementDescription ()
	Returns the requirement description. More...

std::vector< NXString >	GetValidValues ()
	Returns the valid values. More...

NXString	Name ()
	Returns the name of requirement Created in NX8.5.0. More...

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions	RelationalOperatorOption ()
	Returns the relational operator option between expression label and the value in single sided comparison Created in NX8.5.0. More...

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions	RelationalOperatorOptionOnMaximumValue ()
	Returns the relational operator between expression label and maximum value in double sided comparison: [expression] < or <= maximum value. More...

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions	RelationalOperatorOptionOnMinimumValue ()
	Returns the relational operator between minimum value and expression label in double sided comparison: minimum value < or <= [expression]. More...

double	RequirementTolerance ()
	Returns the tolerance for point type requirement Created in NX12.0.0. More...

NXOpen::Validate::RequirementBuilder::RequirementTypeOptions	RequirementTypeOption ()
	Returns the requirement type option Created in NX12.0.0. More...

void	SetDataTypeOption (NXOpen::Validate::RequirementBuilder::DataTypeOptions dataTypeOption)
	Sets the data type option Created in NX8.5.0. More...

void	SetDefinitionMethodOption (NXOpen::Validate::RequirementBuilder::DefinitionMethodOptions definitionMethodOption)
	Sets the definition method option Created in NX8.5.0. More...

void	SetDoubleSidedMaximumValue (const NXString &doubleSidedMaximumValue)
	Sets the maximum value in double sided comparison Created in NX8.5.0. More...

void	SetDoubleSidedMaximumValue (const char *doubleSidedMaximumValue)
	Sets the maximum value in double sided comparison Created in NX8.5.0. More...

void	SetDoubleSidedMinimumValue (const NXString &doubleSidedMinimumValue)
	Sets the minimum value in double sided comparison Created in NX8.5.0. More...

void	SetDoubleSidedMinimumValue (const char *doubleSidedMinimumValue)
	Sets the minimum value in double sided comparison Created in NX8.5.0. More...

void	SetFormula (const NXString &formula)
	Sets. More...

void	SetFormula (const char *formula)
	Sets. More...

void	SetName (const NXString &name)
	Sets the name of requirement Created in NX8.5.0. More...

void	SetName (const char *name)
	Sets the name of requirement Created in NX8.5.0. More...

void	SetRelationalOperatorOption (NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOption)
	Sets the relational operator option between expression label and the value in single sided comparison Created in NX8.5.0. More...

void	SetRelationalOperatorOptionOnMaximumValue (NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOnMaximumValue)
	Sets the relational operator between expression label and maximum value in double sided comparison: [expression] < or <= maximum value. More...

void	SetRelationalOperatorOptionOnMinimumValue (NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOnMinimumValue)
	Sets the relational operator between minimum value and expression label in double sided comparison: minimum value < or <= [expression]. More...

void	SetRequirementDescription (const std::vector< NXString > &requirementDescription)
	Sets the requirement description Created in NX8.5.0. More...

void	SetRequirementTolerance (double requirementTolerance)
	Sets the tolerance for point type requirement Created in NX12.0.0. More...

void	SetRequirementTypeOption (NXOpen::Validate::RequirementBuilder::RequirementTypeOptions requirementTypeOption)
	Sets the requirement type option Created in NX12.0.0. More...

void	SetSeverityOption (NXOpen::Validate::RequirementBuilder::SeverityOptions severityOption)
	Sets the severity option Created in NX8.5.0. More...

void	SetSingleSidedValue (const NXString &singleSidedValue)
	Sets the value for single sided comparison Created in NX8.5.0. More...

void	SetSingleSidedValue (const char *singleSidedValue)
	Sets the value for single sided comparison Created in NX8.5.0. More...

void	SetValidValues (const std::vector< NXString > &validValues)
	Sets the valid values Created in NX8.5.0. More...

NXOpen::Validate::RequirementBuilder::SeverityOptions	SeverityOption ()
	Returns the severity option Created in NX8.5.0. More...

NXString	SingleSidedValue ()
	Returns the value for single sided comparison Created in NX8.5.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

enum NXOpen::Validate::RequirementBuilder::DataTypeOptions

This enum represents the data type of the value in requirement.

Enumerator
DataTypeOptionsNumber	number
DataTypeOptionsString	string
DataTypeOptionsBoolean	boolean
DataTypeOptionsInteger	integer
DataTypeOptionsPoint	point

enum NXOpen::Validate::RequirementBuilder::DefinitionMethodOptions

This enum represents the type of requirement definition method.

Enumerator
DefinitionMethodOptionsSingleSidedComparison	single sided comparison
DefinitionMethodOptionsDoubleSidedComparison	double sided comparison
DefinitionMethodOptionsSetOfValues	set of values
DefinitionMethodOptionsFormula	formula

enum NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions

This enum represents the relational operator for comparing values.

Enumerator
RelationalOperatorOptionsEqual	equal
RelationalOperatorOptionsNotEqual	not equal
RelationalOperatorOptionsLessThan	less than
RelationalOperatorOptionsLessThanOrEqual	less than or equal
RelationalOperatorOptionsGreaterThan	greater than
RelationalOperatorOptionsGreaterThanOrEqual	greater than or equal

enum NXOpen::Validate::RequirementBuilder::RequirementTypeOptions

This enum represents the type of requirement.

Enumerator
RequirementTypeOptionsValidationLimit	validation limit
RequirementTypeOptionsDesignLimit	design limit

enum NXOpen::Validate::RequirementBuilder::SeverityOptions

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

Enumerator
SeverityOptionsError	error
SeverityOptionsWarning	warning
SeverityOptionsInformation	information

Member Function Documentation

NXOpen::Validate::RequirementBuilder::DataTypeOptions NXOpen::Validate::RequirementBuilder::DataTypeOption ( )

Returns the data type option
Created in NX8.5.0.

License requirements : None

NXOpen::Validate::RequirementBuilder::DefinitionMethodOptions NXOpen::Validate::RequirementBuilder::DefinitionMethodOption ( )

Returns the definition method option
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementBuilder::DoubleSidedMaximumValue ( )

Returns the maximum value in double sided comparison
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementBuilder::DoubleSidedMinimumValue ( )

Returns the minimum value in double sided comparison
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementBuilder::Formula ( )

Returns.

the user defined formula. Only effective when NXOpen::Validate::RequirementBuilder::DefinitionMethodOption and NXOpen::Validate::RequirementBuilder::SetDefinitionMethodOption is set to NXOpen::Validate::RequirementBuilder::DefinitionMethodOptionsFormula .

Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::Validate::RequirementBuilder::GetRequirementDescription ( )

Returns the requirement description.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::Validate::RequirementBuilder::GetValidValues ( )

Returns the valid values.

Returns: Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementBuilder::Name ( )

Returns the name of requirement
Created in NX8.5.0.

License requirements : None

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions NXOpen::Validate::RequirementBuilder::RelationalOperatorOption ( )

Returns the relational operator option between expression label and the value in single sided comparison
Created in NX8.5.0.

License requirements : None

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions NXOpen::Validate::RequirementBuilder::RelationalOperatorOptionOnMaximumValue ( )

Returns 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 : None

NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions NXOpen::Validate::RequirementBuilder::RelationalOperatorOptionOnMinimumValue ( )

Returns 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 : None

double NXOpen::Validate::RequirementBuilder::RequirementTolerance ( )

Returns the tolerance for point type requirement
Created in NX12.0.0.

License requirements : None

NXOpen::Validate::RequirementBuilder::RequirementTypeOptions NXOpen::Validate::RequirementBuilder::RequirementTypeOption ( )

Returns the requirement type option
Created in NX12.0.0.

License requirements : None

void NXOpen::Validate::RequirementBuilder::SetDataTypeOption ( NXOpen::Validate::RequirementBuilder::DataTypeOptions dataTypeOption )

Sets the data type option
Created in NX8.5.0.

License requirements : None

Parameters

dataTypeOption datatypeoption

void NXOpen::Validate::RequirementBuilder::SetDefinitionMethodOption ( NXOpen::Validate::RequirementBuilder::DefinitionMethodOptions definitionMethodOption )

Sets the definition method option
Created in NX8.5.0.

License requirements : None

Parameters

definitionMethodOption definitionmethodoption

void NXOpen::Validate::RequirementBuilder::SetDoubleSidedMaximumValue ( const NXString & doubleSidedMaximumValue )

Sets the maximum value in double sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

doubleSidedMaximumValue doublesidedmaximumvalue

void NXOpen::Validate::RequirementBuilder::SetDoubleSidedMaximumValue ( const char * doubleSidedMaximumValue )

Sets the maximum value in double sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

doubleSidedMaximumValue doublesidedmaximumvalue

void NXOpen::Validate::RequirementBuilder::SetDoubleSidedMinimumValue ( const NXString & doubleSidedMinimumValue )

Sets the minimum value in double sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

doubleSidedMinimumValue doublesidedminimumvalue

void NXOpen::Validate::RequirementBuilder::SetDoubleSidedMinimumValue ( const char * doubleSidedMinimumValue )

Sets the minimum value in double sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

doubleSidedMinimumValue doublesidedminimumvalue

void NXOpen::Validate::RequirementBuilder::SetFormula ( const NXString & formula )

Sets.

the user defined formula. Only effective when NXOpen::Validate::RequirementBuilder::DefinitionMethodOption and NXOpen::Validate::RequirementBuilder::SetDefinitionMethodOption is set to NXOpen::Validate::RequirementBuilder::DefinitionMethodOptionsFormula .

Created in NX8.5.0.

License requirements : None

Parameters

formula formula

void NXOpen::Validate::RequirementBuilder::SetFormula ( const char * formula )

Sets.

the user defined formula. Only effective when NXOpen::Validate::RequirementBuilder::DefinitionMethodOption and NXOpen::Validate::RequirementBuilder::SetDefinitionMethodOption is set to NXOpen::Validate::RequirementBuilder::DefinitionMethodOptionsFormula .

Created in NX8.5.0.

License requirements : None

Parameters

formula formula

void NXOpen::Validate::RequirementBuilder::SetName ( const NXString & name )

Sets the name of requirement
Created in NX8.5.0.

License requirements : None

Parameters

name name

void NXOpen::Validate::RequirementBuilder::SetName ( const char * name )

Sets the name of requirement
Created in NX8.5.0.

License requirements : None

Parameters

name name

void NXOpen::Validate::RequirementBuilder::SetRelationalOperatorOption ( NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOption )

Sets the relational operator option between expression label and the value in single sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

relationalOperatorOption relationaloperatoroption

void NXOpen::Validate::RequirementBuilder::SetRelationalOperatorOptionOnMaximumValue ( NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOnMaximumValue )

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 : None

Parameters

relationalOperatorOnMaximumValue relationaloperatoronmaximumvalue

void NXOpen::Validate::RequirementBuilder::SetRelationalOperatorOptionOnMinimumValue ( NXOpen::Validate::RequirementBuilder::RelationalOperatorOptions relationalOperatorOnMinimumValue )

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 : None

Parameters

relationalOperatorOnMinimumValue relationaloperatoronminimumvalue

void NXOpen::Validate::RequirementBuilder::SetRequirementDescription ( const std::vector< NXString > & requirementDescription )

Sets the requirement description
Created in NX8.5.0.

License requirements : None

Parameters

requirementDescription requirementdescription

void NXOpen::Validate::RequirementBuilder::SetRequirementTolerance ( double requirementTolerance )

Sets the tolerance for point type requirement
Created in NX12.0.0.

License requirements : None

Parameters

requirementTolerance tolerance value to be set on requirement

void NXOpen::Validate::RequirementBuilder::SetRequirementTypeOption ( NXOpen::Validate::RequirementBuilder::RequirementTypeOptions requirementTypeOption )

Sets the requirement type option
Created in NX12.0.0.

License requirements : None

Parameters

requirementTypeOption type to set on requirement

void NXOpen::Validate::RequirementBuilder::SetSeverityOption ( NXOpen::Validate::RequirementBuilder::SeverityOptions severityOption )

Sets the severity option
Created in NX8.5.0.

License requirements : None

Parameters

severityOption severityoption

void NXOpen::Validate::RequirementBuilder::SetSingleSidedValue ( const NXString & singleSidedValue )

Sets the value for single sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

singleSidedValue singlesidedvalue

void NXOpen::Validate::RequirementBuilder::SetSingleSidedValue ( const char * singleSidedValue )

Sets the value for single sided comparison
Created in NX8.5.0.

License requirements : None

Parameters

singleSidedValue singlesidedvalue

void NXOpen::Validate::RequirementBuilder::SetValidValues ( const std::vector< NXString > & validValues )

Sets the valid values
Created in NX8.5.0.

License requirements : None

Parameters

validValues validvalues

NXOpen::Validate::RequirementBuilder::SeverityOptions NXOpen::Validate::RequirementBuilder::SeverityOption ( )

Returns the severity option
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementBuilder::SingleSidedValue ( )

Returns the value for single sided comparison
Created in NX8.5.0.

License requirements : None

The documentation for this class was generated from the following file:

Validate_RequirementBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation