NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Validation Class Reference

Represents an NX NXOpen.Validation object. More...

Inheritance diagram for NXOpen.Validation:
NXOpen.NXObject NXOpen.INXObject NXOpen.Validate.RequirementCheck

Public Types

enum  Result {
  Pass, Information, Warning, Failed,
  Unknown, Skipped
}
 Specifies result of the validation More...
 
enum  InputType {
  KfClass, Spreadsheet, TextFile, Xml,
  Tcr, Application, Num
}
 Specifies the input type More...
 
enum  UpdateTime { EveryChange, Save }
 Specifies when to validate More...
 
enum  MapType {
  Text, Real, Int, Time,
  Tag, None
}
 Specifies the map types More...
 
- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

unsafe void SetUpdateControl (NXOpen.Validation.UpdateTime updateTime)
 Define the update behavior of the validation object More...
 
unsafe void Add (string key, NXOpen.NXObject[] objs)
 Add a objects to the validation map More...
 
unsafe void Replace (string key, NXOpen.NXObject[] objs)
 Replace objects of a key in the validation map More...
 
unsafe void Add (string key, string text)
 Add a text to the validation map More...
 
unsafe void Add (string key, double number)
 Add a real to the validation map More...
 
unsafe void Add (string key, int number)
 Add a integer to the validation map More...
 
unsafe void Add (string key, int day, int time)
 Add a time to the validation map More...
 
unsafe NXOpen.Validation.Result Evaluate ()
 Manually validate More...
 
unsafe NXOpen.Validation.Result GetCheckResult ()
 The validation result. More...
 
unsafe void SetCheckResult (NXOpen.Validation.Result result)
 Set the result of validation. More...
 
unsafe string[] GetKeys ()
 Get keys More...
 
unsafe NXOpen.Validation.MapType GetKeyType (string key)
 Get key type More...
 
unsafe void SetUserClassName (string name)
 Set user class name More...
 
unsafe NXOpen.NXObject[] Lookup (string key)
 Lookup a objects to the validation map More...
 
unsafe void LookupNumber (string key, out double number, out bool found)
 Lookup a real to the validation map More...
 
unsafe void LookupText (string key, out string text, out bool found)
 Lookup a text to the validation map More...
 
unsafe void LookupInteger (string key, out int number, out bool found)
 Lookup a integer to the validation map More...
 
unsafe void LookupTime (string key, out int day, out int time, out bool found)
 Lookup a time to the validation map More...
 
unsafe void Remove (string key)
 Remove a key from the map More...
 
unsafe bool GetSuppressed ()
 The suppress state of the validation More...
 
unsafe void SetSuppressed (bool suppress)
  More...
 
unsafe NXOpen.Validation.Result GetInitialResult ()
 The initial result. More...
 
unsafe void Delete ()
 Delete Validation Object More...
 
unsafe void Information ()
 Information display on a Validation Object More...
 
unsafe void GetAssociatedObjects (out NXOpen.NXObject[] objects)
 Gets associated objects for the check. More...
 
unsafe void SetAssociatedObjects (NXOpen.NXObject[] objects)
 Specifies or removes associated objects for the check. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string 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. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe string GetUserAttributeAsString (string 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. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Properties

unsafe string Requirement [get, set]
 Returns or sets the requirement path. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

Represents an NX NXOpen.Validation object.

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

Created in NX4.0.0

Member Enumeration Documentation

Specifies the input type

Enumerator
KfClass 

Input rules are in a KF class

Spreadsheet 

Input rules are from a spreadsheet

TextFile 

Input rules are from a text file

Xml 

Input rules are from XML file

Tcr 

Input rules are from TcR

Application 

Input rules are from validation applications

Num 

Last item define the number of the input source, not used as a type.

Specifies the map types

Enumerator
Text 

Text map

Real 

Real map

Int 

Integer map

Time 

Time map

Tag 

NX Object identifier map

None 

map is not define

Specifies result of the validation

Enumerator
Pass 

Validation Pass all checks

Information 

Validation Pass with information

Warning 

Validation Pass with warning

Failed 

Validation Failed

Unknown 

Unknown validation result

Skipped 

Validation Skipped

Specifies when to validate

Enumerator
EveryChange 

Every update when the input was changed

Save 

During save time

Member Function Documentation

unsafe void NXOpen.Validation.Add ( string  key,
NXOpen.NXObject[]  objs 
)

Add a objects to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
objsObjects to be associate with the key
unsafe void NXOpen.Validation.Add ( string  key,
string  text 
)

Add a text to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
textText to be associate with the key
unsafe void NXOpen.Validation.Add ( string  key,
double  number 
)

Add a real to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
numberReal to be associate with the key
unsafe void NXOpen.Validation.Add ( string  key,
int  number 
)

Add a integer to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
numberInteger to be associate with the key
unsafe void NXOpen.Validation.Add ( string  key,
int  day,
int  time 
)

Add a time to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
dayDate to be associated with the key
timeTime to be associate with the key
unsafe void NXOpen.Validation.Delete ( )

Delete Validation Object

Created in NX4.0.0

License requirements: None.

unsafe NXOpen.Validation.Result NXOpen.Validation.Evaluate ( )

Manually validate

Created in NX4.0.0

License requirements: None.

Returns
unsafe void NXOpen.Validation.GetAssociatedObjects ( out NXOpen.NXObject[]  objects)

Gets associated objects for the check.

Created in NX8.5.0

License requirements: None.

Parameters
objectsObjects associated with the check
unsafe NXOpen.Validation.Result NXOpen.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

Created in NX4.0.0

License requirements: None.

Returns
unsafe NXOpen.Validation.Result NXOpen.Validation.GetInitialResult ( )

The initial result.

Created in NX4.0.0

License requirements: None.

Returns
result of validation object.
unsafe string [] NXOpen.Validation.GetKeys ( )

Get keys

Created in NX4.0.0

License requirements: None.

Returns
keys in the map
unsafe NXOpen.Validation.MapType NXOpen.Validation.GetKeyType ( string  key)

Get key type

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
Returns
unsafe bool NXOpen.Validation.GetSuppressed ( )

The suppress state of the validation

Created in NX4.0.0

License requirements: None.

Returns
Supress flag true = supress false unsupress
unsafe void NXOpen.Validation.Information ( )

Information display on a Validation Object

Created in NX4.0.0

License requirements: None.

unsafe NXOpen.NXObject [] NXOpen.Validation.Lookup ( string  key)

Lookup a objects to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
Returns
objects associate with the key
unsafe void NXOpen.Validation.LookupInteger ( string  key,
out int  number,
out bool  found 
)

Lookup a integer to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
numberInteger associate with the key
foundTrue integer found False not found in map
unsafe void NXOpen.Validation.LookupNumber ( string  key,
out double  number,
out bool  found 
)

Lookup a real to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
numberNumber associate with the key
foundTrue text found False not found in map
unsafe void NXOpen.Validation.LookupText ( string  key,
out string  text,
out bool  found 
)

Lookup a text to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
textText associate with the key
foundTrue text found False not found in map
unsafe void NXOpen.Validation.LookupTime ( string  key,
out int  day,
out int  time,
out bool  found 
)

Lookup a time to the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
dayDate associate with the key
timeTime associate with the key
foundTrue time found False not found in map
unsafe void NXOpen.Validation.Remove ( string  key)

Remove a key from the map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
unsafe void NXOpen.Validation.Replace ( string  key,
NXOpen.NXObject[]  objs 
)

Replace objects of a key in the validation map

Created in NX4.0.0

License requirements: None.

Parameters
keyMap key
objsObjects to be associate with the key
unsafe void NXOpen.Validation.SetAssociatedObjects ( NXOpen.NXObject[]  objects)

Specifies or removes associated objects for the check.

Created in NX8.5.0

License requirements: None.

Parameters
objectsObjects to be associated with the check
unsafe void NXOpen.Validation.SetCheckResult ( NXOpen.Validation.Result  result)

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

Created in NX4.0.0

License requirements: None.

Parameters
result
unsafe void NXOpen.Validation.SetSuppressed ( bool  suppress)

Created in NX4.0.0

License requirements: None.

Parameters
suppressSuppress flag true = supress, false = unsupress
unsafe void NXOpen.Validation.SetUpdateControl ( NXOpen.Validation.UpdateTime  updateTime)

Define the update behavior of the validation object

Created in NX4.0.0

License requirements: None.

Parameters
updateTimeSets the time of update
unsafe void NXOpen.Validation.SetUserClassName ( string  name)

Set user class name

Created in NX4.0.0

License requirements: None.

Parameters
namethe class name

Property Documentation

unsafe string NXOpen.Validation.Requirement
getset

Returns or sets the requirement path.

Created in NX8.0.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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.