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

Represents Routing::DesignRuleViolation object
Design Rule Violation object is created automatically during design rule check

Created in NX4.0.2. More...

Inheritance diagram for NXOpen::Routing::DesignRuleViolation:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

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::DesignRuleViolationLocationGetViolationLocation (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::DesignRuleOverrideOverride ()
 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.

Detailed Description

Represents Routing::DesignRuleViolation object
Design Rule Violation object is created automatically during design rule check

Created in NX4.0.2.



Member Enumeration Documentation

Design Rule Violation Location Object Blank Option.

Enumerator:
BlankOptionBlank 

blank

BlankOptionUnblank 

unblank


Member Function Documentation

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")

Parameters:
objectsobjects

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")

Parameters:
locationObjectsArray of violation locations to be added.

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")

Parameters:
blankOptionblank option

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")

Parameters:
deleteObjectdeleteobject

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

Returns:
Array of Routing::DesignRuleViolationLocation object.
Created in NX6.0.0.

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

Get the array of objects in violation.

Returns:
Caller frees the array
Created in NX4.0.2.

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

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

Returns:
ViolationLocation object at given array position.
Created in NX6.0.0.

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

Violation is overridden or not is inquired.

Returns:

Created in NX4.0.2.

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

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")


Created in NX6.0.0.



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

Parameters:
violationLocationsviolationlocations

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")

Parameters:
longDescriptionlong 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")

Parameters:
objectsCaller frees the array

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")

Parameters:
overrideTagoverridetag

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")

Parameters:
shortDescriptionshort description

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")

Parameters:
timeStamptime stamp

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")

Parameters:
arrayPositionarray position
locationObjectViolationLocation 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")

Parameters:
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.
timestamptimestamp

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")


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