NX Open C++ Reference Guide
|
Represents Routing::DesignRuleViolation object
Design Rule Violation object is created automatically during design rule check
Created in NX4.0.2.
More...
Public Types | |
enum | BlankOption { BlankOptionBlank, BlankOptionUnblank } |
Design Rule Violation Location Object Blank Option. More... | |
Public Member Functions | |
void | AddObjects (const std::vector< NXOpen::Routing::DesignRuleViolation * > &objects) |
Add an object in violation to the violation Created in NX4.0.2. | |
void | AddViolationLocations (const std::vector< NXOpen::Routing::DesignRuleViolationLocation * > &locationObjects) |
This will add given number of violation location objects. | |
void | BlankLocationObjectsOfViolation (NXOpen::Routing::DesignRuleViolation::BlankOption blankOption) |
This function will blank location objects of given violation. | |
void | DeleteRuleOverride (NXOpen::Routing::DesignRuleOverride *deleteObject) |
Override object will be deleted Created in NX4.0.3. | |
std::vector < NXOpen::Routing::DesignRuleViolationLocation * > | GetLocations () |
This will give all violation location objects stored in calling violation object. | |
std::vector< NXOpen::NXObject * > | GetObjects () |
Get the array of objects in violation. | |
NXOpen::Routing::DesignRuleViolationLocation * | GetViolationLocation (int *arrayPosition) |
This will return violation location object stored at given postion of array. | |
bool | IsRuleOverridden () |
Violation is overridden or not is inquired. | |
NXString | LongDescription () |
Returns the long description of the design rule violation is returned Created in NX4.0.0. | |
NXOpen::Routing::DesignRuleOverride * | Override () |
Returns the override object for the violation is inquired Created in NX4.0.2. | |
void | RemoveViolationOverride () |
Removes violation override from given violation object. | |
void | SetLocations (const std::vector< NXOpen::Routing::DesignRuleViolationLocation * > &violationLocations) |
Created in NX6.0.0. | |
void | SetLongDescription (const NXString &longDescription) |
Sets the long description of the design rule violation is returned Created in NX4.0.2. | |
void | SetObjects (const std::vector< NXOpen::NXObject * > &objects) |
Sets the array of objects in violation Created in NX4.0.2. | |
void | SetOverride (NXOpen::Routing::DesignRuleOverride *overrideTag) |
Sets the override object for the violation is inquired Created in NX4.0.2. | |
void | SetShortDescription (const NXString &shortDescription) |
Sets the short description of the design rule violation is returned Created in NX4.0.0. | |
void | SetTimeStamp (int timeStamp) |
Sets the date/time stamp of the violation is inquired Created in NX4.0.2. | |
void | SetViolationLocation (int arrayPosition, NXOpen::Routing::DesignRuleViolationLocation *locationObject) |
This will set violation location object at given postion of array. | |
void | SetViolationOverride (const NXString &user, const NXString &reason, int timestamp) |
Sets the violation override Created in NX4.0.2. | |
NXString | ShortDescription () |
Returns the short description of the design rule violation is returned Created in NX4.0.2. | |
int | TimeStamp () |
Returns the date/time stamp of the violation is inquired Created in NX4.0.2. |
Represents Routing::DesignRuleViolation object
Design Rule Violation object is created automatically during design rule check
Created in NX4.0.2.
void NXOpen::Routing::DesignRuleViolation::AddObjects | ( | const std::vector< NXOpen::Routing::DesignRuleViolation * > & | objects | ) |
Add an object in violation to the violation
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
objects | objects |
void NXOpen::Routing::DesignRuleViolation::AddViolationLocations | ( | const std::vector< NXOpen::Routing::DesignRuleViolationLocation * > & | locationObjects | ) |
This will add given number of violation location objects.
Created in NX6.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
locationObjects | Array of violation locations to be added. |
void NXOpen::Routing::DesignRuleViolation::BlankLocationObjectsOfViolation | ( | NXOpen::Routing::DesignRuleViolation::BlankOption | blankOption | ) |
This function will blank location objects of given violation.
Created in NX6.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
blankOption | blank option |
void NXOpen::Routing::DesignRuleViolation::DeleteRuleOverride | ( | NXOpen::Routing::DesignRuleOverride * | deleteObject | ) |
Override object will be deleted
Created in NX4.0.3.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
deleteObject | deleteobject |
std::vector<NXOpen::Routing::DesignRuleViolationLocation *> NXOpen::Routing::DesignRuleViolation::GetLocations | ( | ) |
This will give all violation location objects stored in calling violation object.
std::vector<NXOpen::NXObject *> NXOpen::Routing::DesignRuleViolation::GetObjects | ( | ) |
Get the array of objects in violation.
NXOpen::Routing::DesignRuleViolationLocation* NXOpen::Routing::DesignRuleViolation::GetViolationLocation | ( | int * | arrayPosition | ) |
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 NULL
arrayPosition | array position |
Violation is overridden or not is inquired.
Returns the long description of the design rule violation is returned
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Returns the override object for the violation is inquired
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Removes violation override from given violation object.
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
void NXOpen::Routing::DesignRuleViolation::SetLocations | ( | const std::vector< NXOpen::Routing::DesignRuleViolationLocation * > & | violationLocations | ) |
Created in NX6.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
violationLocations | violationlocations |
void NXOpen::Routing::DesignRuleViolation::SetLongDescription | ( | const NXString & | longDescription | ) |
Sets the long description of the design rule violation is returned
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
longDescription | long description |
void NXOpen::Routing::DesignRuleViolation::SetObjects | ( | const std::vector< NXOpen::NXObject * > & | objects | ) |
Sets the array of objects in violation
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
objects | Caller frees the array |
void NXOpen::Routing::DesignRuleViolation::SetOverride | ( | NXOpen::Routing::DesignRuleOverride * | overrideTag | ) |
Sets the override object for the violation is inquired
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
overrideTag | overridetag |
void NXOpen::Routing::DesignRuleViolation::SetShortDescription | ( | const NXString & | shortDescription | ) |
Sets the short description of the design rule violation is returned
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
shortDescription | short description |
void NXOpen::Routing::DesignRuleViolation::SetTimeStamp | ( | int | timeStamp | ) |
Sets the date/time stamp of the violation is inquired
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
timeStamp | time stamp |
void NXOpen::Routing::DesignRuleViolation::SetViolationLocation | ( | int | arrayPosition, |
NXOpen::Routing::DesignRuleViolationLocation * | locationObject | ||
) |
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.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
arrayPosition | array position |
locationObject | ViolationLocation object to be set at given array position. |
void NXOpen::Routing::DesignRuleViolation::SetViolationOverride | ( | const NXString & | user, |
const NXString & | reason, | ||
int | timestamp | ||
) |
Sets the violation override
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
user | NOTE: The full Unicode character set is not supported for this parameter. |
reason | NOTE: The full Unicode character set is not supported for this parameter. |
timestamp | timestamp |
Returns the short description of the design rule violation is returned
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Returns the date/time stamp of the violation is inquired
Created in NX4.0.2.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")