Represents NXOpen.Routing.DesignRuleViolation object More...

Inheritance diagram for NXOpen.Routing.DesignRuleViolation:

Public Types
enum	BlankOption { Blank, Unblank }
	Design Rule Violation Location Object Blank Option 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	AddObjects (NXOpen.Routing.DesignRuleViolation[] objects)
	Add an object in violation to the violation More...

unsafe void	AddViolationLocations (NXOpen.Routing.DesignRuleViolationLocation[] locationObjects)
	This will add given number of violation location objects. More...

unsafe void	BlankLocationObjectsOfViolation (NXOpen.Routing.DesignRuleViolation.BlankOption blankOption)
	This function will blank location objects of given violation. More...

unsafe void	DeleteRuleOverride (NXOpen.Routing.DesignRuleOverride deleteObject)
	Override object will be deleted More...

unsafe NXOpen.Routing.DesignRuleViolationLocation[]	GetLocations ()
	This will give all violation location objects stored in calling violation object. More...

unsafe NXOpen.NXObject[]	GetObjects ()
	Get the array of objects in violation More...

unsafe NXOpen.Routing.DesignRule	GetOwningDesignRule ()
	Returns the Design Rule that owns this violation. More...

unsafe NXOpen.Routing.DesignRuleViolationLocation	GetViolationLocation (out int arrayPosition)
	This will return violation location object stored at given postion of array. More...

unsafe bool	IsRuleOverridden ()
	Violation is overridden or not is inquired More...

unsafe void	RemoveViolationOverride ()
	Removes violation override from given violation object. More...

unsafe void	SetLocations (NXOpen.Routing.DesignRuleViolationLocation[] violationLocations)
	More...

unsafe void	SetObjects (NXOpen.NXObject[] objects)
	Sets the array of objects in violation More...

unsafe void	SetViolationLocation (int arrayPosition, NXOpen.Routing.DesignRuleViolationLocation locationObject)
	This will set violation location object at given postion of array. More...

unsafe void	SetViolationOverride (string user, string reason, int timestamp)
	Sets the violation override More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator 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	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	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.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator 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 NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean 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 int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. 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 string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. 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 string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

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

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. 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 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 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 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 bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. 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 NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. 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 NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. 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 void	Print ()
	Prints a representation of this object to the system log file. 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	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 void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. 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 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 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	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	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe string	LongDescription `[get, set]`
	Returns or sets the long description of the design rule violation is returned More...

unsafe NXOpen.Routing.DesignRuleOverride	Override `[get, set]`
	Returns or sets the override object for the violation is inquired More...

unsafe string	ShortDescription `[get, set]`
	Returns or sets the short description of the design rule violation is returned More...

unsafe int	TimeStamp `[get, set]`
	Returns or sets the date and time the violation was created or updated. 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.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents NXOpen.Routing.DesignRuleViolation object

Design Rule Violation object is created automatically during design rule check

Created in NX4.0.2

Member Enumeration Documentation

enum NXOpen.Routing.DesignRuleViolation.BlankOption

Design Rule Violation Location Object Blank Option

Enumerator
Blank
Unblank

Member Function Documentation

unsafe void NXOpen.Routing.DesignRuleViolation.AddObjects ( NXOpen.Routing.DesignRuleViolation[] objects )

inline

Add an object in violation to the violation

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

objects

unsafe void NXOpen.Routing.DesignRuleViolation.AddViolationLocations ( NXOpen.Routing.DesignRuleViolationLocation[] locationObjects )

inline

This will add given number of violation location objects.

Created in NX6.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

locationObjects Array of violation locations to be added.

unsafe void NXOpen.Routing.DesignRuleViolation.BlankLocationObjectsOfViolation ( NXOpen.Routing.DesignRuleViolation.BlankOption blankOption )

inline

This function will blank location objects of given violation.

Created in NX6.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

blankOption

unsafe void NXOpen.Routing.DesignRuleViolation.DeleteRuleOverride ( NXOpen.Routing.DesignRuleOverride deleteObject )

inline

Override object will be deleted

Created in NX4.0.3

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

deleteObject

unsafe NXOpen.Routing.DesignRuleViolationLocation [] NXOpen.Routing.DesignRuleViolation.GetLocations ( )

inline

This will give all violation location objects stored in calling violation object.

Created in NX6.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of NXOpen.Routing.DesignRuleViolationLocation object.

unsafe NXOpen.NXObject [] NXOpen.Routing.DesignRuleViolation.GetObjects ( )

inline

Get the array of objects in violation

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Caller frees the array

unsafe NXOpen.Routing.DesignRule NXOpen.Routing.DesignRuleViolation.GetOwningDesignRule ( )

inline

Returns the Design Rule that owns this violation.

Created in NX12.0.1

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.DesignRuleViolationLocation NXOpen.Routing.DesignRuleViolation.GetViolationLocation ( out int arrayPosition )

inline

This will return violation location object stored at given postion of array.

If there is no object at the given position, it will give appropriate message. and return a null reference (Nothing in Visual Basic)

Created in NX6.0.0

Deprecated in NX8.0.3. Use NXOpen.Routing.DesignRuleViolation.GetLocations instead.

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

arrayPosition

Returns: ViolationLocation object at given array position.

unsafe bool NXOpen.Routing.DesignRuleViolation.IsRuleOverridden ( )

inline

Violation is overridden or not is inquired

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.DesignRuleViolation.RemoveViolationOverride ( )

inline

Removes violation override from given violation object.

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe void NXOpen.Routing.DesignRuleViolation.SetLocations ( NXOpen.Routing.DesignRuleViolationLocation[] violationLocations )

inline

Created in NX6.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

violationLocations

unsafe void NXOpen.Routing.DesignRuleViolation.SetObjects ( NXOpen.NXObject[] objects )

inline

Sets the array of objects in violation

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

objects Caller frees the array

unsafe void NXOpen.Routing.DesignRuleViolation.SetViolationLocation	(	int	arrayPosition,
		NXOpen.Routing.DesignRuleViolationLocation	locationObject
	)

inline

This will set violation location object at given postion of array.

If there is already an object at the given position, it will delete that object and set with new one.

Created in NX6.0.0

Deprecated in NX8.0.3. Use NXOpen.Routing.DesignRuleViolation.AddViolationLocations instead.

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

arrayPosition
locationObject	ViolationLocation object to be set at given array position.

unsafe void NXOpen.Routing.DesignRuleViolation.SetViolationOverride	(	string	user,
		string	reason,
		int	timestamp
	)

inline

Sets the violation override

Created in NX4.0.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

user
reason
timestamp

Property Documentation

unsafe string NXOpen.Routing.DesignRuleViolation.LongDescription

getset

Returns or sets the long description of the design rule violation is returned

Created in NX4.0.0

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.Routing.DesignRuleOverride NXOpen.Routing.DesignRuleViolation.Override

getset

Returns or sets the override object for the violation is inquired

Created in NX4.0.2

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe string NXOpen.Routing.DesignRuleViolation.ShortDescription

getset

Returns or sets the short description of the design rule violation is returned

Created in NX4.0.2

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe int NXOpen.Routing.DesignRuleViolation.TimeStamp

getset

Returns or sets the date and time the violation was created or updated.

* The time stamp is number of seconds since the UNIX epoch (midnight GMT, 1 January 1970).

Created in NX4.0.2

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

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

Routing_DesignRuleViolation.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation