UF_RULE_add_rule_violations (view source)
Defined in: uf_rule.h
Overview
Sets the violations of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_add_rule_violations
(
tag_t rule,
int num_violations,
tag_t * violations
)
| tag_t | rule | Input | Tag of the rule to modify. |
| int | num_violations | Input | Number of violations. |
| tag_t * | violations | Input | Violations array. |
UF_RULE_add_violation_objects (view source)
Defined in: uf_rule.h
Overview
Adds objects to a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_add_violation_objects
(
tag_t violation,
int num_objects,
tag_t * objects
)
| tag_t | violation | Input | Tag of violation to modify. |
| int | num_objects | Input | Number of objects to add. |
| tag_t * | objects | Input | Array of added objects. |
UF_RULE_ask_function_library (view source)
Defined in: uf_rule.h
Overview
Returns the library of a function.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_function_library
(
tag_t function,
char * * library
)
| tag_t | function | Input | Tag of function to inquire. |
| char * * | library | Output to UF_*free* | Shared Library / Image. |
UF_RULE_ask_function_name (view source)
Defined in: uf_rule.h
Overview
Returns the name of a function.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_function_name
(
tag_t function,
char * * name
)
| tag_t | function | Input | Tag of function to inquire. |
| char * * | name | Output to UF_*free* | Name of function. |
UF_RULE_ask_function_rules (view source)
Defined in: uf_rule.h
Overview
Returns the rules of a function.
Environment
Internal and External
Required License(s)
gateway
int UF_RULE_ask_function_rules
(
tag_t function,
int * num_rules,
tag_t * * rules
)
| tag_t | function | Input | Tag of function to inquire. |
| int * | num_rules | Output | Number of rules returned. |
| tag_t * * | rules | Output to UF_*free* | Array of rules. This array must be freed by calling UF_free. |
UF_RULE_ask_object_violations (view source)
Defined in: uf_rule.h
Overview
Inquire the violations which include this object
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_object_violations
(
tag_t object,
int * num_violations,
tag_t * * violations
)
| tag_t | object | Input | The object to inquire |
| int * | num_violations | Output | The number of violations returned |
| tag_t * * | violations | Output to UF_*free* | The array of violations. This must be freed by calling
UF_free. |
UF_RULE_ask_override_reason (view source)
Defined in: uf_rule.h
Overview
Returns the reason of an override.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_override_reason
(
tag_t override,
char * * reason
)
| tag_t | override | Input | Tag of override to inquire. |
| char * * | reason | Output to UF_*free* | Reason for override (May have carriage returns). |
UF_RULE_ask_override_time_stamp (view source)
Defined in: uf_rule.h
Overview
Returns the time stamp of an override.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_override_time_stamp
(
tag_t override,
int * time_stamp
)
| tag_t | override | Input | Tag of override to inquire. |
| int * | time_stamp | Output | Date/Time. |
UF_RULE_ask_override_user (view source)
Defined in: uf_rule.h
Overview
Sets the user of an override
Environment
Internal and External
History
Original release was in V14.0
Required License(s)
gateway
int UF_RULE_ask_override_user
(
tag_t override,
char * * user
)
| tag_t | override | Input | Tag of override to modify. |
| char * * | user | Output to UF_*free* | New user. |
UF_RULE_ask_override_violations (view source)
Defined in: uf_rule.h
Overview
Returns the violations overridden by an override.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_override_violations
(
tag_t override,
int * num_violations,
tag_t * * violations
)
| tag_t | override | Input | Tag of override to inquire. |
| int * | num_violations | Output | Number of violations. |
| tag_t * * | violations | Output to UF_*free* | Array of violations. This array must be freed by
calling UF_free. |
UF_RULE_ask_rule_application (view source)
Defined in: uf_rule.h
Overview
Returns the application of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_application
(
tag_t rule,
char * * application
)
| tag_t | rule | Input | Tag of the rule to query. |
| char * * | application | Output to UF_*free* | Application of the rule. |
UF_RULE_ask_rule_check_function (view source)
Defined in: uf_rule.h
Overview
Returns the check function of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_check_function
(
tag_t rule,
tag_t * check_function
)
| tag_t | rule | Input | Tag of the rule to query. |
| tag_t * | check_function | Output | Tag of function object. |
UF_RULE_ask_rule_description (view source)
Defined in: uf_rule.h
Overview
Returns the description of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_description
(
tag_t rule,
char * * description
)
| tag_t | rule | Input | Tag of the rule to query. |
| char * * | description | Output to UF_*free* | Description of the rule. |
UF_RULE_ask_rule_name (view source)
Defined in: uf_rule.h
Overview
Returns the name of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_name
(
tag_t rule,
char * * name
)
| tag_t | rule | Input | Tag of the rule to query. |
| char * * | name | Output to UF_*free* | Name of the rule. |
UF_RULE_ask_rule_vios (view source)
Defined in: uf_rule.h
Overview
Returns the violations of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_vios
(
tag_t rule,
int * num_violations,
tag_t * * violations
)
| tag_t | rule | Input | Tag of the rule to query. |
| int * | num_violations | Output | Number of violations returned. |
| tag_t * * | violations | Output to UF_*free* | Violations array. This array must be freed by
calling UF_free. |
UF_RULE_ask_rule_vios_since (view source)
Defined in: uf_rule.h
Overview
Returns the violations of a design rule since a particular date.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_rule_vios_since
(
tag_t rule,
int since,
int * num_violations,
tag_t * * violations
)
| tag_t | rule | Input | Tag of the rule to inquire. |
| int | since | Input | Date (Number of seconds since Jan 1,
1970 00:00:00 GMT). |
| int * | num_violations | Output | Number of violations returned. |
| tag_t * * | violations | Output to UF_*free* | Violations array. This array must be freed by calling
UF_free. |
UF_RULE_ask_vio_long_desc (view source)
Defined in: uf_rule.h
Overview
Returns the long description of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_long_desc
(
tag_t violation,
char * * long_desc
)
| tag_t | violation | Input | Tag of violation to query. |
| char * * | long_desc | Output to UF_*free* | Verbose description of violation. |
UF_RULE_ask_vio_objects (view source)
Defined in: uf_rule.h
Overview
Returns the objects of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_objects
(
tag_t violation,
int * num_objects,
tag_t * * objects
)
| tag_t | violation | Input | Tag of violation to inquire. |
| int * | num_objects | Output | Number of objects to returned. |
| tag_t * * | objects | Output to UF_*free* | Array of objects. This array must be freed by calling
UF_free. |
UF_RULE_ask_vio_override (view source)
Defined in: uf_rule.h
Overview
Returns the override of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_override
(
tag_t violation,
tag_t * override
)
| tag_t | violation | Input | Tag of violation to inquire. |
| tag_t * | override | Output | Tag of override object. |
UF_RULE_ask_vio_rule (view source)
Defined in: uf_rule.h
Overview
Returns the rule of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_rule
(
tag_t violation,
tag_t * rule
)
| tag_t | violation | Input | Tag of violation to inquire. |
| tag_t * | rule | Output | Tag of rule. |
UF_RULE_ask_vio_short_desc (view source)
Defined in: uf_rule.h
Overview
Returns the short description of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_short_desc
(
tag_t violation,
char * * short_desc
)
| tag_t | violation | Input | Tag of violation to inquire. |
| char * * | short_desc | Output to UF_*free* | Terse description of violation. |
UF_RULE_ask_vio_time_stamp (view source)
Defined in: uf_rule.h
Overview
Returns the time_stamp of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_ask_vio_time_stamp
(
tag_t violation,
int * time_stamp
)
| tag_t | violation | Input | Tag of violation to inquire. |
| int * | time_stamp | Output | Time in seconds since Jan 1, 1970
00:00:00 GMT. |
UF_RULE_check_rule (view source)
Defined in: uf_rule.h
Overview
Checks a design rule. The violations are returned using the
time_stamps of the violations that have been created since the check
started. This is done so that the check function does not have to
allocate and return an array of the violations created.
However, the check function is responsible for creating the violation
and attaching the violation to the rule. Otherwise, the new violations
are not found.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_check_rule
(
tag_t rule,
void * data,
int * num_violations,
tag_t * * violations
)
| tag_t | rule | Input | Tag of the rule to check. |
| void * | data | Input | Client data to be passed to
check_function. |
| int * | num_violations | Output | Number of violations created. |
| tag_t * * | violations | Output to UF_*free* | Violations created. This array must be freed by
calling UF_free. |
UF_RULE_check_rules (view source)
Defined in: uf_rule.h
Overview
Checks many design rules.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_check_rules
(
int num_rules,
tag_t * rules,
void * data,
int * num_violations,
tag_t * * violations
)
| int | num_rules | Input | Number of rules to check. |
| tag_t * | rules | Input | Array of rules to check. |
| void * | data | Input | Client data to be passed to
check_function. |
| int * | num_violations | Output | Number of violations created. |
| tag_t * * | violations | Output to UF_*free* | Array of violations created. This array must be freed
by calling UF_free. |
UF_RULE_create_function (view source)
Defined in: uf_rule.h
Overview
Creates a function.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_create_function
(
tag_t object_in_part,
char * name,
char * library,
tag_t * function
)
| tag_t | object_in_part | Input | Tag of object in same part to create function. |
| char * | name | Input | Name of function. |
| char * | library | Input | Name of shared library / image. |
| tag_t * | function | Output | Tag of new function. |
UF_RULE_create_or_update_vio (view source)
Defined in: uf_rule.h
Overview
Finds the violation of the given rule by the given object. If there is none,
a new violation is created. If the violation is updated, only the short and
long descriptions are updated.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_create_or_update_vio
(
tag_t object,
tag_t rule,
char * short_description,
char * long_description,
int num_objects,
tag_t objects [ ] ,
tag_t * violation
)
| tag_t | object | Input | Tag of the object in violation |
| tag_t | rule | Input | Tag of the rule which the object violates |
| char * | short_description | Input | Short description of the violation |
| char * | long_description | Input | Long description of the violation |
| int | num_objects | Input | Number of objects in violation |
| tag_t | objects [ ] | Input | Tags of objects in violation |
| tag_t * | violation | Output | Tag of the violation |
UF_RULE_create_override (view source)
Defined in: uf_rule.h
Overview
Creates an override object.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_create_override
(
tag_t object_in_part,
char * user,
char * reason,
int time_stamp,
tag_t * override
)
| tag_t | object_in_part | Input | Tag of object in same part to create
override. |
| char * | user | Input | Name of user. |
| char * | reason | Input | Reason for the override taking place |
| int | time_stamp | Input | Time in seconds since Jan 1, 1970
00:00:00 GMT. |
| tag_t * | override | Output | Tag of new override object |
UF_RULE_create_rule (view source)
Defined in: uf_rule.h
Overview
Create a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_create_rule
(
tag_t object_in_part,
char * name,
char * description,
char * application,
tag_t check_function,
tag_t * rule
)
| tag_t | object_in_part | Input | Tag of the object in the same part to
create the new rule object. (May be a
part tag). |
| char * | name | Input | Name of the rule. |
| char * | description | Input | Description of the rule. |
| char * | application | Input | Application of the rule. |
| tag_t | check_function | Input | Tag of a design Rule Function. |
| tag_t * | rule | Output | Tag of new rule. |
UF_RULE_create_violation (view source)
Defined in: uf_rule.h
Overview
Creates a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_create_violation
(
tag_t object_in_part,
char * short_description,
char * long_description,
int num_objects,
tag_t objects [ ] ,
int time_stamp,
tag_t * violation
)
| tag_t | object_in_part | Input | Tag of object in same part to create
violation object. May be a part tag. May
not be NULL_TAG. |
| char * | short_description | Input | Terse description of violation. |
| char * | long_description | Input | Verbose description of violation. |
| int | num_objects | Input | Number of objects in the violation. |
| tag_t | objects [ ] | Input | Objects in the violation. |
| int | time_stamp | Input | Date created : number of seconds since 1
Jan 1970 00:00:00. Use
UF_RULE_CURRENT_TIME_STAMP
for current time. |
| tag_t * | violation | Output | Tag of new violation object. |
UF_RULE_delete_vio_by_obj_rule (view source)
Defined in: uf_rule.h
Overview
FInds the violation of the given rule by the given object and deletes it.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_delete_vio_by_obj_rule
(
tag_t object,
tag_t rule
)
| tag_t | object | Input | Tag of the object in violation |
| tag_t | rule | Input | Tag of the rule which the object violates |
UF_RULE_find_vio_by_obj_rule (view source)
Defined in: uf_rule.h
Overview
FInds the violation of the given rule by the given object. If the given
object does not violate the rule, NULL_TAG is returned.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_find_vio_by_obj_rule
(
tag_t object,
tag_t rule,
tag_t * violation
)
| tag_t | object | Input | Tag of the object in violation |
| tag_t | rule | Input | Tag of the rule which the object violates |
| tag_t * | violation | Output | Tag of the violation by the given object of the given rule |
UF_RULE_is_violation_overridden (view source)
Defined in: uf_rule.h
Overview
Asks if the violation is overridden.
Return
TRUE or FALSE.
Environment
Internal and External
Required License(s)
gateway
logical UF_RULE_is_violation_overridden
(
tag_t violation
)
| tag_t | violation | Input | Tag of violation to inquire. |
UF_RULE_is_violation_since (view source)
Defined in: uf_rule.h
Overview
Asks if the violation was created since the given date/time.
Return
TRUE - Created After
FALSE - Create on or before.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
logical UF_RULE_is_violation_since
(
tag_t violation,
int since
)
| tag_t | violation | Input | Tag of violation to inquire. |
| int | since | Input | Time in seconds since Jan 1, 1970
00:00:00 GMT. |
UF_RULE_resolve_function (view source)
Defined in: uf_rule.h
Overview
Returns the pointer to the actual function associated with a rule. This
is the address of the C function which should be invoked, e.g.,
(func) ( rule, data );
NULL is returned for "func" if there is no function for this rule
Returns
ERROR_OK or error code
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_resolve_function
(
tag_t function,
UF_RULE_check_function_f_t * func
)
UF_RULE_set_function_library (view source)
Defined in: uf_rule.h
Overview
Sets the library of a function.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_function_library
(
tag_t function,
char * library
)
| tag_t | function | Input | Tag of function to modify. |
| char * | library | Input | Shared Library / Image. |
UF_RULE_set_function_name (view source)
Defined in: uf_rule.h
Overview
Sets the name of a function.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_function_name
(
tag_t function,
char * name
)
| tag_t | function | Input | Tag of function to modify. |
| char * | name | Input | New name of function. |
UF_RULE_set_override_reason (view source)
Defined in: uf_rule.h
Overview
Sets the reason of an override.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_override_reason
(
tag_t override,
char * reason
)
| tag_t | override | Input | Tag of override to modify. |
| char * | reason | Input | Reason for override. |
UF_RULE_set_override_time_stamp (view source)
Defined in: uf_rule.h
Overview
Sets the time stamp of an override.
Environment
Internal and External
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_override_time_stamp
(
tag_t override,
int time_stamp
)
| tag_t | override | Input | Tag of override to modify. |
| int | time_stamp | Input | Date/Time. |
UF_RULE_set_override_user (view source)
Defined in: uf_rule.h
Overview
Sets the user of an override
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_override_user
(
tag_t override,
char * user
)
| tag_t | override | Input | Tag of override to modify. |
| char * | user | Input | New user. |
UF_RULE_set_rule_application (view source)
Defined in: uf_rule.h
Overview
Sets the application of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_rule_application
(
tag_t rule,
char * application
)
| tag_t | rule | Input | Tag of the rule to query. |
| char * | application | Input | New application for the rule. |
UF_RULE_set_rule_check_function (view source)
Defined in: uf_rule.h
Overview
Sets the check function of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_rule_check_function
(
tag_t rule,
tag_t check_function
)
| tag_t | rule | Input | Tag of the rule to modify. |
| tag_t | check_function | Input | Tag of UF_RULE_function object. |
UF_RULE_set_rule_description (view source)
Defined in: uf_rule.h
Overview
Sets the description of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_rule_description
(
tag_t rule,
char * description
)
| tag_t | rule | Input | Tag of the rule to modify. |
| char * | description | Input | New description of the rule. |
UF_RULE_set_rule_name (view source)
Defined in: uf_rule.h
Overview
Sets the name of a Design Rule.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_rule_name
(
tag_t rule,
char * name
)
| tag_t | rule | Input | Tag of the rule to modify. |
| char * | name | Input | New name of the rule. |
UF_RULE_set_rule_violations (view source)
Defined in: uf_rule.h
Overview
Set the violations of a rule
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_rule_violations
(
tag_t rule,
int num_violations,
tag_t violations [ ]
)
| tag_t | rule | Input | Tag of rule to modify |
| int | num_violations | Input | Number of violations |
| tag_t | violations [ ] | Input | Array of violations |
UF_RULE_set_vio_long_desc (view source)
Defined in: uf_rule.h
Overview
Sets the long description of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_vio_long_desc
(
tag_t violation,
char * long_desc
)
| tag_t | violation | Input | Tag of violation to modify. |
| char * | long_desc | Input | Verbose description of violation. |
UF_RULE_set_vio_objects (view source)
Defined in: uf_rule.h
Overview
Sets the objects of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_vio_objects
(
tag_t violation,
int num_objects,
tag_t objects [ ]
)
| tag_t | violation | Input | Tag of violation to modify. |
| int | num_objects | Input | Number of objects. |
| tag_t | objects [ ] | Input | Array of objects. |
UF_RULE_set_vio_override (view source)
Defined in: uf_rule.h
Overview
Sets the override of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_vio_override
(
tag_t violation,
tag_t override
)
| tag_t | violation | Input | Tag of violation to modify. |
| tag_t | override | Input | Tag of override object. |
UF_RULE_set_vio_short_desc (view source)
Defined in: uf_rule.h
Overview
Sets the short description of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
gateway
int UF_RULE_set_vio_short_desc
(
tag_t violation,
char * short_desc
)
| tag_t | violation | Input | Tag of violation to modify. |
| char * | short_desc | Input | Terse description of violation. |
UF_RULE_set_vio_time_stamp (view source)
Defined in: uf_rule.h
Overview
Sets the time_stamp of a violation.
Environment
Internal and External
History
Original release was in V14.0.
Required License(s)
( routing_base or routing_advanced )
int UF_RULE_set_vio_time_stamp
(
tag_t violation,
int time_stamp
)
| tag_t | violation | Input | Tag of violation to inquire. |
| int | time_stamp | Input | Time in seconds since Jan 1, 1970
00:00:00 GMT. Use
UF_RULE_CURRENT_TIME_STAMP
for current time. |