NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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

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. More...
 
NXOpen::Routing::DesignRuleViolationViewer::FilterOption FilterOptionValue ()
 Returns the value for filter option of route Design Rule Violation
Created in NX6.0.0. More...
 
std::vector< NXStringGetOverrideText ()
 Returns the text written as a reason for overriding the violation. More...
 
bool NavigateViolationLocationOption ()
 Returns the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations. More...
 
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. More...
 
void SetDialogViolationId (int dialogViolationID)
 Sets the dialog design rule violation Id
Created in NX6.0.0. More...
 
void SetFilterOptionValue (NXOpen::Routing::DesignRuleViolationViewer::FilterOption filterOptionValue)
 Sets the value for filter option of route Design Rule Violation
Created in NX6.0.0. More...
 
void SetNavigateViolationLocationOption (bool navigateViolationLocationOption)
 Sets the state of Violation Location toggle option, if true: Navigate Violation Locations of current violation if false: Navigate Violations. More...
 
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. More...
 
void SetOverrideText (const std::vector< NXString > &overrideText)
 Sets the text for reason of overriding the violation
Created in NX6.0.0. More...
 
void SetUsername (const NXString &username)
 Sets the username who has overridden design Rule violation
Created in NX6.0.0. More...
 
void SetUsername (const char *username)
 Sets the username who has overridden design Rule violation
Created in NX6.0.0. More...
 
NXString Username ()
 Returns the username who has overridden design Rule violation
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

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 NXOpen::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

int NXOpen::Routing::DesignRuleViolationViewer::DialogViolationId ( )

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



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

NXOpen::Routing::DesignRuleViolationViewer::FilterOption NXOpen::Routing::DesignRuleViolationViewer::FilterOptionValue ( )

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



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

std::vector<NXString> NXOpen::Routing::DesignRuleViolationViewer::GetOverrideText ( )

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

Returns

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
bool NXOpen::Routing::DesignRuleViolationViewer::NavigateViolationLocationOption ( )

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::Routing::DesignRuleViolationViewer::OverrideOption NXOpen::Routing::DesignRuleViolationViewer::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.



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

void NXOpen::Routing::DesignRuleViolationViewer::SetDialogViolationId ( int  dialogViolationID)

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



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

Parameters
dialogViolationIDdialogviolationid
void NXOpen::Routing::DesignRuleViolationViewer::SetFilterOptionValue ( NXOpen::Routing::DesignRuleViolationViewer::FilterOption  filterOptionValue)

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



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

Parameters
filterOptionValuefilter option value
void NXOpen::Routing::DesignRuleViolationViewer::SetNavigateViolationLocationOption ( bool  navigateViolationLocationOption)

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
navigateViolationLocationOptionnavigateviolationlocationoption
void NXOpen::Routing::DesignRuleViolationViewer::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.



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

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
overrideTextoverridetext
void NXOpen::Routing::DesignRuleViolationViewer::SetUsername ( const NXString username)

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



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

Parameters
usernameusername
void NXOpen::Routing::DesignRuleViolationViewer::SetUsername ( const char *  username)

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



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

Parameters
usernameusername
NXString NXOpen::Routing::DesignRuleViolationViewer::Username ( )

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



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


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