Represents a check-mate result object. More...

Inheritance diagram for NXOpen::Validate::ResultObject:

Public Types
enum	ResultTypes { ResultTypesPart, ResultTypesProfile, ResultTypesTest, ResultTypesObject, ResultTypesObjectSet }
	The type of check result. 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	CategoryName ()
	Returns the category name of check result. More...

NXString	ClassName ()
	Returns the class name of check result. More...

NXOpen::Validate::OverrideBuilder *	CreateOverrideBuilder (NXOpen::Validate::Override *overrideRequest)
	Creates a NXOpen::Validate::OverrideBuilder. More...

void	DeleteOverride ()
	Deletes user override request NXOpen::Validate::Override . More...

bool	Disabled ()
	Returns the disabled status of check result. More...

NXString	Name ()
	Returns the name of check result More...

bool	OutOfDate ()
	Returns the out of date status of check result. More...

NXOpen::Validate::Override *	Override ()
	Returns the override request object of check result Created in NX8.5.0. More...

void	SetName (const NXString &name)
	Sets the name of check result More...

void	SetName (const char *name)
	Sets the name of check result More...

void	SetStatus (NXOpen::Validation::Result status)
	Sets the error status of check result Created in NX7.5.0. More...

void	SetType (NXOpen::Validate::ResultObject::ResultTypes type)
	Sets the type of check result Created in NX7.5.0. More...

NXOpen::Validation::Result	Status ()
	Returns the error status of check result Created in NX7.5.0. More...

int	TotalObjectsCount ()
	Returns the total objects count of check result. More...

NXOpen::Validate::ResultObject::ResultTypes	Type ()
	Returns the type of check result Created in NX7.5.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 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...

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 a check-mate result object.

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Validate::ResultObject::ResultTypes

The type of check result.

Enumerator
ResultTypesPart	Part.
ResultTypesProfile	Profile.
ResultTypesTest	Test.
ResultTypesObject	Object.
ResultTypesObjectSet	Object Set.

Member Function Documentation

NXString NXOpen::Validate::ResultObject::CategoryName ( )

Returns the category name of check result.

Return empty if the ResultObject has no this property.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::ResultObject::ClassName ( )

Returns the class name of check result.

Return empty if the ResultObject has no this property.

Created in NX8.5.0.

License requirements : None

NXOpen::Validate::OverrideBuilder* NXOpen::Validate::ResultObject::CreateOverrideBuilder ( NXOpen::Validate::Override * overrideRequest )

Creates a NXOpen::Validate::OverrideBuilder.

Returns: Created in NX8.5.0.

License requirements : ug_checkmate ("UG Check Mate")

Parameters

overrideRequest override request

void NXOpen::Validate::ResultObject::DeleteOverride ( )

Deletes user override request NXOpen::Validate::Override .

Created in NX8.5.0.

License requirements : ug_checkmate ("UG Check Mate")

bool NXOpen::Validate::ResultObject::Disabled ( )

Returns the disabled status of check result.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::Validate::ResultObject::Name ( )

virtual

Returns the name of check result

Deprecated:: Deprecated in NX9.0.0.

Use NXOpen::NXObject::Name and NXOpen::NXObject::SetName instead.

Created in NX7.5.0.

License requirements : None

Reimplemented from NXOpen::NXObject.

bool NXOpen::Validate::ResultObject::OutOfDate ( )

Returns the out of date status of check result.

Returns error code if part is unloaded. Result of unloaded part is assumed up to date. The program may not be able to detect the modifications in the part.

Created in NX8.5.0.

License requirements : None

NXOpen::Validate::Override* NXOpen::Validate::ResultObject::Override ( )

Returns the override request object of check result
Created in NX8.5.0.

License requirements : None

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

virtual

Sets the name of check result

Deprecated:: Deprecated in NX9.0.0.

Use NXOpen::NXObject::Name and NXOpen::NXObject::SetName instead.

Created in NX7.5.0.

License requirements : None

Parameters

name	The name of check result

Reimplemented from NXOpen::NXObject.

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

virtual

Sets the name of check result

Deprecated:: Deprecated in NX9.0.0.

Use NXOpen::NXObject::Name and NXOpen::NXObject::SetName instead.

Created in NX7.5.0.

License requirements : None

Parameters

name	The name of check result

Reimplemented from NXOpen::NXObject.

void NXOpen::Validate::ResultObject::SetStatus ( NXOpen::Validation::Result status )

Sets the error status of check result
Created in NX7.5.0.

License requirements : None

Parameters

status The error level

void NXOpen::Validate::ResultObject::SetType ( NXOpen::Validate::ResultObject::ResultTypes type )

Sets the type of check result
Created in NX7.5.0.

License requirements : None

Parameters

type	The result type

NXOpen::Validation::Result NXOpen::Validate::ResultObject::Status ( )

Returns the error status of check result
Created in NX7.5.0.

License requirements : None

int NXOpen::Validate::ResultObject::TotalObjectsCount ( )

Returns the total objects count of check result.

Return zero if the ResultObject has no this property.

Created in NX8.5.0.

License requirements : None

NXOpen::Validate::ResultObject::ResultTypes NXOpen::Validate::ResultObject::Type ( )

Returns the type of check result
Created in NX7.5.0.

License requirements : None

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

Validate_ResultObject.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation