NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::DesignRuleViolationViewer Class Reference

This class can be used to set the violation id, update text for overridding the violation and update the user name used to override the violation. More...

Inheritance diagram for NXOpen::Routing::DesignRuleViolationViewer:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  FilterOption { FilterOptionAllViolations, FilterOptionSkipOverrides, FilterOptionOverridesOnly }
 Enumerations to show options for filter. More...
enum  OverrideOption { OverrideOptionYes, OverrideOptionNo }
 Enumerations to show options for override. More...

Public Member Functions

int DialogViolationId ()
 Returns the dialog design rule violation Id
Created in NX6.0.0.
NXOpen::Routing::DesignRuleViolationViewer::FilterOption FilterOptionValue ()
 Returns the value for filter option of route Design Rule Violation
Created in NX6.0.0.
std::vector< NXStringGetOverrideText ()
 Returns the text written as a reason for overriding the violation.
bool NavigateViolationLocationOption ()
 Returns the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.
NXOpen::Routing::DesignRuleViolationViewer::OverrideOption OverrideOptionValue ()
 Returns the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden
Created in NX6.0.0.
void SetDialogViolationId (int dialogViolationID)
 Sets the dialog design rule violation Id
Created in NX6.0.0.
void SetFilterOptionValue (NXOpen::Routing::DesignRuleViolationViewer::FilterOption filterOptionValue)
 Sets the value for filter option of route Design Rule Violation
Created in NX6.0.0.
void SetNavigateViolationLocationOption (bool navigateViolationLocationOption)
 Sets the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.
void SetOverrideOptionValue (NXOpen::Routing::DesignRuleViolationViewer::OverrideOption overrideOptionValue)
 Sets the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden
Created in NX6.0.0.
void SetOverrideText (const std::vector< NXString > &overrideText)
 Sets the text for reason of overriding the violation
Created in NX6.0.0.
void SetUsername (const NXString &username)
 Sets the username who has overridden design Rule violation
Created in NX6.0.0.
NXString Username ()
 Returns the username who has overridden design Rule violation
Created in NX6.0.0.

Detailed Description

This class can be used to set the violation id, update text for overridding the violation and update the user name used to override the violation.


To create a new instance of this class, use Routing::RouteManager::CreateDesignRuleViolationViewer
Default values.

Property Value

DialogViolationId

0

FilterOptionValue

AllViolations

NavigateViolationLocationOption

true

OverrideOptionValue

No


Created in NX6.0.0.


Member Enumeration Documentation

Enumerations to show options for filter.

Enumerator:
FilterOptionAllViolations 

will show all violations

FilterOptionSkipOverrides 

will not show overridden violations

FilterOptionOverridesOnly 

will show only overridden violations

Enumerations to show options for override.

Enumerator:
OverrideOptionYes 

this shows that current violation is overridden violations

OverrideOptionNo 

this shows that current violation is not overridden.


Member Function Documentation

Returns the dialog design rule violation Id
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the value for filter option of route Design Rule Violation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the text written as a reason for overriding the violation.

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the dialog design rule violation Id
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
dialogViolationIDdialogviolationid

Sets the value for filter option of route Design Rule Violation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
filterOptionValuefilter option value

Sets the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
navigateViolationLocationOptionnavigateviolationlocationoption

Sets the value for design Rule Violation override option if Yes: violation is overridden if No: violation is not overridden
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
overrideOptionValueoverride option value
void NXOpen::Routing::DesignRuleViolationViewer::SetOverrideText ( const std::vector< NXString > &  overrideText)

Sets the text for reason of overriding the violation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
overrideTextoverridetext

Sets the username who has overridden design Rule violation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
usernameusername

Returns the username who has overridden design Rule violation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.