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

Inheritance diagram for NXOpen::Validation:

Public Types
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
void	Add (const NXString &key, const std::vector< NXOpen::NXObject * > &objs)
	Add a objects to the validation map Created in NX4.0.0. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	GetSuppressed ()
	The suppress state of the validation. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

NXString	Requirement ()
	Returns the requirement path. More...

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

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

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...

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

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

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. More...

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. More...

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. More...

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. More...

void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...

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...

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

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

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

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

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

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

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

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

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

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

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

bool	GetNextUserAttribute (NXOpen::AttributeIterator iterator, NXOpen::NXObject::AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

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

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

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. More...

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. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

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...

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

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

std::vector < 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...

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

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

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

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

int	GetUserAttributeSize (const char *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...

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

bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...

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 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...

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 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...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

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

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

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

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

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. More...

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. More...

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

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

void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetPdmReferenceAttribute (const char attributeTitle, const char attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

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

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

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. More...

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. More...

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

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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

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

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

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

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

enum NXOpen::Validation::InputType

Specifies the input type.

Enumerator
InputTypeKfClass	Input rules are in a KF class.
InputTypeSpreadsheet	Input rules are from a spreadsheet.
InputTypeTextFile	Input rules are from a text file.
InputTypeXml	Input rules are from XML file.
InputTypeTcr	Input rules are from TcR.
InputTypeApplication	Input rules are from validation applications.
InputTypeNum	Last item define the number of the input source, not used as a type.

enum NXOpen::Validation::MapType

Specifies the map types.

Enumerator
MapTypeText	Text map.
MapTypeReal	Real map.
MapTypeInt	Integer map.
MapTypeTime	Time map.
MapTypeTag	NX Object identifier map.
MapTypeNone	map is not define

enum NXOpen::Validation::Result

Specifies result of the validation.

Enumerator
ResultPass	Validation Pass all checks.
ResultInformation	Validation Pass with information.
ResultWarning	Validation Pass with warning.
ResultFailed	Validation Failed.
ResultUnknown	Unknown validation result.
ResultSkipped	Validation Skipped.

enum NXOpen::Validation::UpdateTime

Specifies when to validate.

Enumerator
UpdateTimeEveryChange	Every update when the input was changed.
UpdateTimeSave	During save time.

Member Function Documentation

void NXOpen::Validation::Add	(	const NXString &	key,
		const std::vector< NXOpen::NXObject * > &	objs
	)

Add a objects to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
objs	Objects to be associate with the key

void NXOpen::Validation::Add	(	const char *	key,
		const std::vector< NXOpen::NXObject * > &	objs
	)

Add a objects to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
objs	Objects to be associate with the key

void NXOpen::Validation::Add	(	const NXString &	key,
		const NXString &	text
	)

Add a text to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
text	Text to be associate with the key

void NXOpen::Validation::Add	(	const char *	key,
		const char *	text
	)

Add a text to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
text	Text to be associate with the key

void NXOpen::Validation::Add	(	const NXString &	key,
		double	number
	)

Add a real to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Real to be associate with the key

void NXOpen::Validation::Add	(	const char *	key,
		double	number
	)

Add a real to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Real to be associate with the key

void NXOpen::Validation::Add	(	const NXString &	key,
		int	number
	)

Add a integer to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Integer to be associate with the key

void NXOpen::Validation::Add	(	const char *	key,
		int	number
	)

Add a integer to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Integer to be associate with the key

void NXOpen::Validation::Add	(	const NXString &	key,
		int	day,
		int	time
	)

Add a time to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
day	Date to be associated with the key
time	Time to be associate with the key

void NXOpen::Validation::Add	(	const char *	key,
		int	day,
		int	time
	)

Add a time to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
day	Date to be associated with the key
time	Time to be associate with the key

void NXOpen::Validation::Delete ( )

Delete Validation Object
Created in NX4.0.0.

License requirements : None

NXOpen::Validation::Result NXOpen::Validation::Evaluate ( )

Manually validate.

Returns: Created in NX4.0.0.

License requirements : None

void NXOpen::Validation::GetAssociatedObjects ( std::vector< NXOpen::NXObject * > & objects )

Gets associated objects for the check.

Created in NX8.5.0.

License requirements : None

Parameters

objects Objects associated with the check

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

Returns: Created in NX4.0.0.

License requirements : None

NXOpen::Validation::Result NXOpen::Validation::GetInitialResult ( )

The initial result.

Returns: result of validation object.
Created in NX4.0.0.

License requirements : None

std::vector<NXString> NXOpen::Validation::GetKeys ( )

Get keys.

Returns: keys in the map
Created in NX4.0.0.

License requirements : None

NXOpen::Validation::MapType NXOpen::Validation::GetKeyType ( const NXString & key )

Get key type.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

key Map key

NXOpen::Validation::MapType NXOpen::Validation::GetKeyType ( const char * key )

Get key type.

Returns: Created in NX4.0.0.

License requirements : None

Parameters

key Map key

bool NXOpen::Validation::GetSuppressed ( )

The suppress state of the validation.

Returns: Supress flag true = supress false unsupress
Created in NX4.0.0.

License requirements : None

void NXOpen::Validation::Information ( )

Information display on a Validation Object
Created in NX4.0.0.

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Validation::Lookup ( const NXString & key )

Lookup a objects to the validation map.

Returns: objects associate with the key
Created in NX4.0.0.

License requirements : None

Parameters

key Map key

std::vector<NXOpen::NXObject *> NXOpen::Validation::Lookup ( const char * key )

Lookup a objects to the validation map.

Returns: objects associate with the key
Created in NX4.0.0.

License requirements : None

Parameters

key Map key

void NXOpen::Validation::LookupInteger	(	const NXString &	key,
		int *	number,
		bool *	found
	)

Lookup a integer to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Integer associate with the key
found	True integer found False not found in map

void NXOpen::Validation::LookupInteger	(	const char *	key,
		int *	number,
		bool *	found
	)

Lookup a integer to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Integer associate with the key
found	True integer found False not found in map

void NXOpen::Validation::LookupNumber	(	const NXString &	key,
		double *	number,
		bool *	found
	)

Lookup a real to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Number associate with the key
found	True text found False not found in map

void NXOpen::Validation::LookupNumber	(	const char *	key,
		double *	number,
		bool *	found
	)

Lookup a real to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
number	Number associate with the key
found	True text found False not found in map

void NXOpen::Validation::LookupText	(	const NXString &	key,
		NXString *	text,
		bool *	found
	)

Lookup a text to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
text	Text associate with the key
found	True text found False not found in map

void NXOpen::Validation::LookupText	(	const char *	key,
		NXString *	text,
		bool *	found
	)

Lookup a text to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
text	Text associate with the key
found	True text found False not found in map

void NXOpen::Validation::LookupTime	(	const NXString &	key,
		int *	day,
		int *	time,
		bool *	found
	)

Lookup a time to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
day	Date associate with the key
time	Time associate with the key
found	True time found False not found in map

void NXOpen::Validation::LookupTime	(	const char *	key,
		int *	day,
		int *	time,
		bool *	found
	)

Lookup a time to the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
day	Date associate with the key
time	Time associate with the key
found	True time found False not found in map

void NXOpen::Validation::Remove ( const NXString & key )

Remove a key from the map
Created in NX4.0.0.

License requirements : None

Parameters

key Map key

void NXOpen::Validation::Remove ( const char * key )

Remove a key from the map
Created in NX4.0.0.

License requirements : None

Parameters

key Map key

void NXOpen::Validation::Replace	(	const NXString &	key,
		const std::vector< NXOpen::NXObject * > &	objs
	)

Replace objects of a key in the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
objs	Objects to be associate with the key

void NXOpen::Validation::Replace	(	const char *	key,
		const std::vector< NXOpen::NXObject * > &	objs
	)

Replace objects of a key in the validation map
Created in NX4.0.0.

License requirements : None

Parameters

key	Map key
objs	Objects to be associate with the key

NXString NXOpen::Validation::Requirement ( )

Returns the requirement path.

Created in NX8.0.0.

License requirements : None

void NXOpen::Validation::SetAssociatedObjects ( const std::vector< NXOpen::NXObject * > & objects )

Specifies or removes associated objects for the check.

Created in NX8.5.0.

License requirements : None

Parameters

objects Objects to be associated with the check

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 result

void NXOpen::Validation::SetRequirement ( const NXString & requirement )

Sets the requirement path.

Created in NX8.0.0.

License requirements : None

Parameters

requirement requirement path

void NXOpen::Validation::SetRequirement ( const char * requirement )

Sets the requirement path.

Created in NX8.0.0.

License requirements : None

Parameters

requirement requirement path

void NXOpen::Validation::SetSuppressed ( bool suppress )

Created in NX4.0.0.

License requirements : None

Parameters

suppress Suppress flag true = supress, false = unsupress

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

updateTime Sets the time of update

void NXOpen::Validation::SetUserClassName ( const NXString & name )

Set user class name
Created in NX4.0.0.

License requirements : None

Parameters

name	the class name

void NXOpen::Validation::SetUserClassName ( const char * name )

Set user class name
Created in NX4.0.0.

License requirements : None

Parameters

name	the class name

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

Validation.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation