NXOpen::Routing::DesignRuleViolationCollection Class Reference

Represents a collection of NXOpen::Routing::DesignRuleViolation objects. More...

Inheritance diagram for NXOpen::Routing::DesignRuleViolationCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Types
enum	Mode { ModeConcurrent, ModeInteractive, ModeBatch }
	Design Rule Mode. More...
enum	Reason {   ReasonUnknown, ReasonCreatePath, ReasonHealPath, ReasonAssignCorner,   ReasonAssignStock, ReasonRemoveStock, ReasonStockStyle, ReasonPlacePart,   ReasonCreateFab, ReasonQualifyPart, ReasonMovePath, ReasonCopyPath,   ReasonDeletePath, ReasonSubdivideSeg, ReasonSimplifyPath, ReasonRemovePart,   ReasonMovePart, ReasonEditCharx, ReasonInteractive, ReasonBatch,   ReasonOrientStock, ReasonUnifyPath, ReasonTransformPath, ReasonOffsetPath,   ReasonAutoRoutePin, ReasonManualRoutePin, ReasonAutoRouteComp, ReasonManualRouteComp,   ReasonImport, ReasonPartialAutoRouteComp, ReasonEditPlacePart, ReasonBulkReplacement }
	Design Rule reason. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element. More...
NXOpen::Routing::DesignRuleViolation *	CreateDesignRuleViolation (const NXString &shortDescription, const NXString &longDescription, const std::vector< NXOpen::NXObject * > &objects)
	Creates a NXOpen::Routing::DesignRuleViolation object. More...
NXOpen::Routing::DesignRuleViolation *	CreateDesignRuleViolation (const char *shortDescription, const char *longDescription, const std::vector< NXOpen::NXObject * > &objects)
	Creates a NXOpen::Routing::DesignRuleViolation object. More...
iterator	end ()
	Returns an iterator addressing one past the last element. More...
std::vector < NXOpen::Routing::DesignRuleViolation * >	ReasonExecuteRule (NXOpen::Routing::DesignRuleViolationCollection::Mode mode, NXOpen::Routing::DesignRuleViolationCollection::Reason reason, const std::vector< NXOpen::NXObject * > &objs)
	Executes design rules and returns all the violations of the rule. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a collection of NXOpen::Routing::DesignRuleViolation objects.

To obtain an instance of this class, refer to NXOpen::Routing::RouteManager

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::DesignRuleViolationCollection::Mode

Design Rule Mode.

Enumerator
ModeConcurrent	Executes design rules on all concurrently logged objects. Use LogConcurrent method on NXOpen::Routing::RouteManager to concurrently logged objects and GetConcurrent method to get all the concurrent objects
ModeInteractive	Execute design rules during next interactive check.
ModeBatch	Executes design rules in a batch process.

enum NXOpen::Routing::DesignRuleViolationCollection::Reason

Design Rule reason.

Enumerator
ReasonUnknown	unknown
ReasonCreatePath	create path
ReasonHealPath	heal path
ReasonAssignCorner	assign corner
ReasonAssignStock	assign stock
ReasonRemoveStock	remove stock
ReasonStockStyle	stock style
ReasonPlacePart	place part
ReasonCreateFab	create fab
ReasonQualifyPart	qualify part
ReasonMovePath	move path
ReasonCopyPath	copy path
ReasonDeletePath	delete path
ReasonSubdivideSeg	subdivide seg
ReasonSimplifyPath	simplify path
ReasonRemovePart	remove part
ReasonMovePart	move part
ReasonEditCharx	edit charx
ReasonInteractive	interactive
ReasonBatch	batch
ReasonOrientStock	orient stock
ReasonUnifyPath	unify path
ReasonTransformPath	transform path
ReasonOffsetPath	offset path
ReasonAutoRoutePin	auto route pin
ReasonManualRoutePin	manual route pin
ReasonAutoRouteComp	auto route comp
ReasonManualRouteComp	manual route comp
ReasonImport	import
ReasonPartialAutoRouteComp	partial auto route comp
ReasonEditPlacePart	edit place part
ReasonBulkReplacement	bulk replacement

Member Function Documentation

iterator NXOpen::Routing::DesignRuleViolationCollection::begin

(

)

Returns an iterator addressing the first element.

NXOpen::Routing::DesignRuleViolation* NXOpen::Routing::DesignRuleViolationCollection::CreateDesignRuleViolation	(	const NXString &	shortDescription,
		const NXString &	longDescription,
		const std::vector< NXOpen::NXObject * > &	objects
	)

Creates a NXOpen::Routing::DesignRuleViolation object.

Once created, you must add the violation to a rule using NXOpen::Routing::DesignRule::AddViolations .

Returns

Deprecated:

Deprecated in NX11.0.0. Use Routing::DesignRule::CreateViolation instead.

Created in NX4.0.2.

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

Parameters

shortDescription	short description
longDescription	long description
objects	objects

NXOpen::Routing::DesignRuleViolation* NXOpen::Routing::DesignRuleViolationCollection::CreateDesignRuleViolation	(	const char *	shortDescription,
		const char *	longDescription,
		const std::vector< NXOpen::NXObject * > &	objects
	)

Creates a NXOpen::Routing::DesignRuleViolation object.

Once created, you must add the violation to a rule using NXOpen::Routing::DesignRule::AddViolations .

Returns

Deprecated:

Deprecated in NX11.0.0. Use Routing::DesignRule::CreateViolation instead.

Created in NX4.0.2.

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

Parameters

shortDescription	short description
longDescription	long description
objects	objects

iterator NXOpen::Routing::DesignRuleViolationCollection::end

(

)

Returns an iterator addressing one past the last element.

std::vector<NXOpen::Routing::DesignRuleViolation *> NXOpen::Routing::DesignRuleViolationCollection::ReasonExecuteRule	(	NXOpen::Routing::DesignRuleViolationCollection::Mode	mode,
		NXOpen::Routing::DesignRuleViolationCollection::Reason	reason,
		const std::vector< NXOpen::NXObject * > &	objs
	)

Executes design rules and returns all the violations of the rule.

Returns

Violations
Created in NX4.0.0.

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

Parameters

mode	Design Rule Mode
reason	Design Rule Reason
objs	Objects to check the design rule violation against

tag_t NXOpen::Routing::DesignRuleViolationCollection::Tag

(

)

const

Returns the tag of this object.

---

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

• Routing_DesignRuleViolationCollection.hxx