Represents an NX Validate::RequirementCheck object. More...

Inheritance diagram for NXOpen::Validate::RequirementCheck:

Public Types
enum	SaveResultsToTeamcenterOptions { SaveResultsToTeamcenterOptionsDoNotSave, SaveResultsToTeamcenterOptionsSaveIfPassed, SaveResultsToTeamcenterOptionsAlwaysSave }
	This enum represents the Save Results to Teamcenter option. More...

Public Types inherited from NXOpen::Validation
enum	InputType { InputTypeKfClass, InputTypeSpreadsheet, InputTypeTextFile, InputTypeXml, InputTypeTcr, InputTypeApplication, InputTypeNum }
	Specifies the input type. More...

enum	MapType { MapTypeText, MapTypeReal, MapTypeInt, MapTypeTime, MapTypeTag, MapTypeNone }
	Specifies the map types. More...

enum	Result { ResultPass, ResultInformation, ResultWarning, ResultFailed, ResultUnknown, ResultSkipped }
	Specifies result of the validation. More...

enum	UpdateTime { UpdateTimeEveryChange, UpdateTimeSave }
	Specifies when to validate. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
NXString	CheckName ()
	Returns the name of requirement check shown in Requirements Validation dialog Created in NX8.5.0.

NXString	Formula ()
	Returns the formula of requirement check Created in NX8.5.0.

NXOpen::Validate::Requirement *	ParentRequirement ()
	Returns the parent Validate::Requirement Created in NX8.5.0.

NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOptions	SaveResultsToTeamcenterOption ()
	Returns the Save Results to Teamcenter option Created in NX8.5.0.

void	SetCheckName (const NXString &checkName)
	Sets the name of requirement check shown in Requirements Validation dialog Created in NX8.5.0.

void	SetCheckName (const char *checkName)
	Sets the name of requirement check shown in Requirements Validation dialog Created in NX8.5.0.

void	SetFormula (const NXString &formula)
	Sets the formula of requirement check.

void	SetFormula (const char *formula)
	Sets the formula of requirement check.

void	SetParentRequirement (NXOpen::Validate::Requirement *parentRequirement)
	Sets the parent Validate::Requirement Created in NX8.5.0.

void	SetSaveResultsToTeamcenterOption (NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOptions option)
	Sets the Save Results to Teamcenter option Created in NX8.5.0.

Public Member Functions inherited from NXOpen::Validation
void	Add (const NXString &key, const std::vector< NXOpen::NXObject * > &objs)
	Add a objects to the validation map Created in NX4.0.0.

void	Add (const char key, const std::vector< NXOpen::NXObject > &objs)
	Add a objects to the validation map Created in NX4.0.0.

void	Add (const NXString &key, const NXString &text)
	Add a text to the validation map Created in NX4.0.0.

void	Add (const char key, const char text)
	Add a text to the validation map Created in NX4.0.0.

void	Add (const NXString &key, double number)
	Add a real to the validation map Created in NX4.0.0.

void	Add (const char *key, double number)
	Add a real to the validation map Created in NX4.0.0.

void	Add (const NXString &key, int number)
	Add a integer to the validation map Created in NX4.0.0.

void	Add (const char *key, int number)
	Add a integer to the validation map Created in NX4.0.0.

void	Add (const NXString &key, int day, int time)
	Add a time to the validation map Created in NX4.0.0.

void	Add (const char *key, int day, int time)
	Add a time to the validation map Created in NX4.0.0.

void	Delete ()
	Delete Validation Object Created in NX4.0.0.

NXOpen::Validation::Result	Evaluate ()
	Manually validate.

void	GetAssociatedObjects (std::vector< NXOpen::NXObject * > &objects)
	Gets associated objects for the check.

NXOpen::Validation::Result	GetCheckResult ()
	The validation result.

NXOpen::Validation::Result	GetInitialResult ()
	The initial result.

std::vector< NXString >	GetKeys ()
	Get keys.

NXOpen::Validation::MapType	GetKeyType (const NXString &key)
	Get key type.

NXOpen::Validation::MapType	GetKeyType (const char *key)
	Get key type.

bool	GetSuppressed ()
	The suppress state of the validation.

void	Information ()
	Information display on a Validation Object Created in NX4.0.0.

std::vector< NXOpen::NXObject * >	Lookup (const NXString &key)
	Lookup a objects to the validation map.

std::vector< NXOpen::NXObject * >	Lookup (const char *key)
	Lookup a objects to the validation map.

void	LookupInteger (const NXString &key, int number, bool found)
	Lookup a integer to the validation map Created in NX4.0.0.

void	LookupInteger (const char key, int number, bool *found)
	Lookup a integer to the validation map Created in NX4.0.0.

void	LookupNumber (const NXString &key, double number, bool found)
	Lookup a real to the validation map Created in NX4.0.0.

void	LookupNumber (const char key, double number, bool *found)
	Lookup a real to the validation map Created in NX4.0.0.

void	LookupText (const NXString &key, NXString text, bool found)
	Lookup a text to the validation map Created in NX4.0.0.

void	LookupText (const char key, NXString text, bool *found)
	Lookup a text to the validation map Created in NX4.0.0.

void	LookupTime (const NXString &key, int day, int time, bool *found)
	Lookup a time to the validation map Created in NX4.0.0.

void	LookupTime (const char key, int day, int time, bool found)
	Lookup a time to the validation map Created in NX4.0.0.

void	Remove (const NXString &key)
	Remove a key from the map Created in NX4.0.0.

void	Remove (const char *key)
	Remove a key from the map Created in NX4.0.0.

void	Replace (const NXString &key, const std::vector< NXOpen::NXObject * > &objs)
	Replace objects of a key in the validation map Created in NX4.0.0.

void	Replace (const char key, const std::vector< NXOpen::NXObject > &objs)
	Replace objects of a key in the validation map Created in NX4.0.0.

NXString	Requirement ()
	Returns the requirement path.

void	SetAssociatedObjects (const std::vector< NXOpen::NXObject * > &objects)
	Specifies or removes associated objects for the check.

void	SetCheckResult (NXOpen::Validation::Result result)
	Set the result of validation.

void	SetRequirement (const NXString &requirement)
	Sets the requirement path.

void	SetRequirement (const char *requirement)
	Sets the requirement path.

void	SetSuppressed (bool suppress)
	Created in NX4.0.0.

void	SetUpdateControl (NXOpen::Validation::UpdateTime updateTime)
	Define the update behavior of the validation object Created in NX4.0.0.

void	SetUserClassName (const NXString &name)
	Set user class name Created in NX4.0.0.

void	SetUserClassName (const char *name)
	Set user class name Created in NX4.0.0.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &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.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *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.

NXString	GetUserAttributeAsString (const NXString &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.

NXString	GetUserAttributeAsString (const char *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.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

Represents an NX Validate::RequirementCheck object.

<br> To create a new instance of this class, use @link Validate::RequirementCheckCollection::CreateRequirementCheck  Validate::RequirementCheckCollection::CreateRequirementCheck @endlink  <br>

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOptions

This enum represents the Save Results to Teamcenter option.

Enumerator:

SaveResultsToTeamcenterOptionsDoNotSave	Do not perform save.
SaveResultsToTeamcenterOptionsSaveIfPassed	Perform save only if the result is passed.
SaveResultsToTeamcenterOptionsAlwaysSave	Always perform save.

Member Function Documentation

NXString NXOpen::Validate::RequirementCheck::CheckName ( )

Returns the name of requirement check shown in Requirements Validation dialog
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::RequirementCheck::Formula ( )

Returns the formula of requirement check
Created in NX8.5.0.

License requirements : None

NXOpen::Validate::Requirement* NXOpen::Validate::RequirementCheck::ParentRequirement ( )

Returns the parent Validate::Requirement
Created in NX8.5.0.

License requirements : None

NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOptions NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOption ( )

Returns the Save Results to Teamcenter option
Created in NX8.5.0.

License requirements : None

void NXOpen::Validate::RequirementCheck::SetCheckName ( const NXString & checkName )

Sets the name of requirement check shown in Requirements Validation dialog
Created in NX8.5.0.

License requirements : None

Parameters

checkName checkname

void NXOpen::Validate::RequirementCheck::SetCheckName ( const char * checkName )

Sets the name of requirement check shown in Requirements Validation dialog
Created in NX8.5.0.

License requirements : None

Parameters

checkName checkname

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

Sets the formula of requirement check.

The requirement check will be re-evaluated.
Created in NX8.5.0.

License requirements : None

Parameters

formula formula

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

Sets the formula of requirement check.

The requirement check will be re-evaluated.
Created in NX8.5.0.

License requirements : None

Parameters

formula formula

void NXOpen::Validate::RequirementCheck::SetParentRequirement ( NXOpen::Validate::Requirement * parentRequirement )

Sets the parent Validate::Requirement
Created in NX8.5.0.

License requirements : None

Parameters

parentRequirement parentrequirement

void NXOpen::Validate::RequirementCheck::SetSaveResultsToTeamcenterOption ( NXOpen::Validate::RequirementCheck::SaveResultsToTeamcenterOptions option )

Sets the Save Results to Teamcenter option
Created in NX8.5.0.

License requirements : None

Parameters

option option

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

Validate_RequirementCheck.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation