Validation Class¶

class NXOpen.Validation¶

Bases: NXOpen.NXObject

Represents an NX NXOpen.Validation object.

To create a new instance of this class, use NXOpen.ValidationCollection.Create()

New in version NX4.0.0.

Properties¶

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Requirement	Returns or sets the requirement path.
Tag	Returns the Tag for this object.

Methods¶

Method	Description
Add	Add a objects to the validation map
CreateAttributeIterator	Create an attribute iterator
Delete	Delete Validation Object
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
Evaluate	Manually validate
FindObject	Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GetAssociatedObjects	Gets associated objects for the check.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetCheckResult	The validation result.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetInitialResult	The initial result.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetKeyType	Get key type
GetKeys	Get keys
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetSuppressed	The suppress state of the validation
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Information	Information display on a Validation Object
Lookup	Lookup a objects to the validation map
LookupInteger	Lookup a integer to the validation map
LookupNumber	Lookup a real to the validation map
LookupText	Lookup a text to the validation map
LookupTime	Lookup a time to the validation map
Print	Prints a representation of this object to the system log file.
Remove	Remove a key from the map
Replace	Replace objects of a key in the validation map
SetAssociatedObjects	Specifies or removes associated objects for the check.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetCheckResult	Set the result of validation.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetSuppressed
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUpdateControl	Define the update behavior of the validation object
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
SetUserClassName	Set user class name

Enumerations¶

ValidationInputType Enumeration	Specifies the input type
ValidationMapType Enumeration	Specifies the map types
ValidationResult Enumeration	Specifies result of the validation
ValidationUpdateTime Enumeration	Specifies when to validate

Property Detail¶

IsOccurrence¶

Validation.IsOccurrence¶

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:	This object is an occurrence
Return type:	bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier¶

Validation.JournalIdentifier¶

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

Name¶

Validation.Name¶

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

OwningComponent¶

Validation.OwningComponent¶

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns:
Return type:	`NXOpen.Assemblies.Component`

New in version NX3.0.0.

License requirements: None.

OwningPart¶

Validation.OwningPart¶

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:	The owning part of this object or null if it does not have an owner
Return type:	`NXOpen.BasePart`

New in version NX3.0.0.

License requirements: None.

Prototype¶

Validation.Prototype¶

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:	The prototype of this object or null if this object is not an occurrence
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

Requirement¶

Validation.Requirement¶

Returns or sets the requirement path.

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

Getter Method

Signature Requirement

Returns:	requirement path
Return type:	str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Requirement

Parameters:	requirement (str) – requirement path

New in version NX8.0.0.

License requirements: None.

Method Detail¶

Add¶

Validation.Add¶

Overloaded method Add

Add(key, objs)
Add(key, text)
Add(key, number)
Add(key, number)
Add(key, day, time)

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

Add a objects to the validation map

Signature Add(key, objs)

Parameters:	key (str) – Map key objs (list of `NXOpen.NXObject`) – Objects to be associate with the key

New in version NX4.0.0.

License requirements: None.

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

Add a text to the validation map

Signature Add(key, text)

Parameters:	key (str) – Map key text (str) – Text to be associate with the key

New in version NX4.0.0.

License requirements: None.

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

Add a real to the validation map

Signature Add(key, number)

Parameters:	key (str) – Map key number (float) – Real to be associate with the key

New in version NX4.0.0.

License requirements: None.

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

Add a integer to the validation map

Signature Add(key, number)

Parameters:	key (str) – Map key number (int) – Integer to be associate with the key

New in version NX4.0.0.

License requirements: None.

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

Add a time to the validation map

Signature Add(key, day, time)

Parameters:	key (str) – Map key day (int) – Date to be associated with the key time (int) – Time to be associate with the key

New in version NX4.0.0.

License requirements: None.

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

Delete¶

Validation.Delete¶

Delete Validation Object

Signature Delete()

New in version NX4.0.0.

License requirements: None.

Evaluate¶

Validation.Evaluate¶

Manually validate

Signature Evaluate()

Returns:
Return type:	`NXOpen.ValidationResult`

New in version NX4.0.0.

License requirements: None.

FindObject¶

Validation.FindObject¶

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:	journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

GetAssociatedObjects¶

Validation.GetAssociatedObjects¶

Gets associated objects for the check.

Signature GetAssociatedObjects()

Returns:	Objects associated with the check
Return type:	list of `NXOpen.NXObject`

New in version NX8.5.0.

License requirements: None.

GetCheckResult¶

Validation.GetCheckResult¶

The validation result.

Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result

Signature GetCheckResult()

Returns:
Return type:	`NXOpen.ValidationResult`

New in version NX4.0.0.

License requirements: None.

GetInitialResult¶

Validation.GetInitialResult¶

The initial result.

Signature GetInitialResult()

Returns:	result of validation object.
Return type:	`NXOpen.ValidationResult`

New in version NX4.0.0.

License requirements: None.

GetKeyType¶

Validation.GetKeyType¶

Get key type

Signature GetKeyType(key)

Parameters:	key (str) – Map key
Returns:
Return type:	`NXOpen.ValidationMapType`

New in version NX4.0.0.

License requirements: None.

GetKeys¶

Validation.GetKeys¶

Get keys

Signature GetKeys()

Returns:	keys in the map
Return type:	list of str

New in version NX4.0.0.

License requirements: None.

GetSuppressed¶

Validation.GetSuppressed¶

The suppress state of the validation

Signature GetSuppressed()

Returns:	Supress flag true = supress false unsupress
Return type:	bool

New in version NX4.0.0.

License requirements: None.

Information¶

Validation.Information¶

Information display on a Validation Object

Signature Information()

New in version NX4.0.0.

License requirements: None.

Lookup¶

Validation.Lookup¶

Lookup a objects to the validation map

Signature Lookup(key)

Parameters:	key (str) – Map key
Returns:	objects associate with the key
Return type:	list of `NXOpen.NXObject`

New in version NX4.0.0.

License requirements: None.

LookupInteger¶

Validation.LookupInteger¶

Lookup a integer to the validation map

Signature LookupInteger(key)

Parameters:	key (str) – Map key
Returns:	a tuple
Return type:	A tuple consisting of (number, found) number is a int. Integer associate with the key found is a bool. True integer found False not found in map

New in version NX4.0.0.

License requirements: None.

LookupNumber¶

Validation.LookupNumber¶

Lookup a real to the validation map

Signature LookupNumber(key)

Parameters:	key (str) – Map key
Returns:	a tuple
Return type:	A tuple consisting of (number, found) number is a float. Number associate with the key found is a bool. True text found False not found in map

New in version NX4.0.0.

License requirements: None.

LookupText¶

Validation.LookupText¶

Lookup a text to the validation map

Signature LookupText(key)

Parameters:	key (str) – Map key
Returns:	a tuple
Return type:	A tuple consisting of (text, found) text is a str. Text associate with the key found is a bool. True text found False not found in map

New in version NX4.0.0.

License requirements: None.

LookupTime¶

Validation.LookupTime¶

Lookup a time to the validation map

Signature LookupTime(key)

Parameters:	key (str) – Map key
Returns:	a tuple
Return type:	A tuple consisting of (day, time, found) day is a int. Date associate with the key time is a int. Time associate with the key found is a bool. True time found False not found in map

New in version NX4.0.0.

License requirements: None.

Print¶

Validation.Print¶

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

Remove¶

Validation.Remove¶

Remove a key from the map

Signature Remove(key)

Parameters:	key (str) – Map key

New in version NX4.0.0.

License requirements: None.

Replace¶

Validation.Replace¶

Replace objects of a key in the validation map

Signature Replace(key, objs)

Parameters:	key (str) – Map key objs (list of `NXOpen.NXObject`) – Objects to be associate with the key

New in version NX4.0.0.

License requirements: None.

SetAssociatedObjects¶

Validation.SetAssociatedObjects¶

Specifies or removes associated objects for the check.

Signature SetAssociatedObjects(objects)

Parameters:	objects (list of `NXOpen.NXObject`) – Objects to be associated with the check

New in version NX8.5.0.

License requirements: None.

SetCheckResult¶

Validation.SetCheckResult¶

Set the result of validation.

Result is represented as a Name, with the following options: pass : Validation Pass all checks information : Validation Pass with information warning : Validation Pass with warning failed : Validation Failed unknown : Unknown validation result

Signature SetCheckResult(result)

Parameters:	result (`NXOpen.ValidationResult`) –

New in version NX4.0.0.

License requirements: None.

SetName¶

Validation.SetName¶

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:	name (str) –

New in version NX3.0.0.

License requirements: None.

SetSuppressed¶

Validation.SetSuppressed¶

Signature SetSuppressed(suppress)

Parameters:	suppress (bool) – Suppress flag true = supress, false = unsupress

New in version NX4.0.0.

License requirements: None.

SetUpdateControl¶

Validation.SetUpdateControl¶

Define the update behavior of the validation object

Signature SetUpdateControl(updateTime)

Parameters:	updateTime (`NXOpen.ValidationUpdateTime`) – Sets the time of update

New in version NX4.0.0.

License requirements: None.

SetUserClassName¶

Validation.SetUserClassName¶

Set user class name

Signature SetUserClassName(name)

Parameters:	name (str) – the class name

New in version NX4.0.0.

License requirements: None.