ITK Function Reference

(V10000.1.0.60_20160308.00)
Modules | Functions
MDL0MODEL

Modules

 MDL0MODEL Errors
 

Functions

MDL0MODEL_API int MDL0MODEL_ask_deep_revise_data (tag_t conditional_element_tag, int *n_deep_revise_data, tag_t **deep_revise_data)
 
MDL0MODEL_API int MDL0MODEL_free_deep_revise_data (int n_deep_revise_data, tag_t *deep_revise_data)
 
MDL0MODEL_API int MDL0MODEL_get_impacted_welds (int n_design_element_objects, const tag_t *design_element_objects, tag_t configuration_context, int *n_impacted_welds, tag_t **impacted_welds, tag_t **ret_design_element_objects)
 
MDL0MODEL_API int MDL0MODEL_query_related_objects (int n_source_objects, const tag_t *source_objects, tag_t configuration_context, const char *relation_type_name, const char *other_side_object_type_name, const char *attribute_name, int attribute_type, const char *attribute_value, logical query_primaries, logical return_relations, int *n_related_objects, tag_t **related_objects, tag_t **ret_source_objects, tag_t **relation_objects)
 
MDL0MODEL_API int MDL0MODEL_revise_object (tag_t conditional_element_tag, tag_t revise_input, int n_deep_revise_data, const tag_t *deep_revise_data, tag_t *new_element_revision)
 

Detailed Description

Function Documentation

MDL0MODEL_API int MDL0MODEL_ask_deep_revise_data ( tag_t  conditional_element_tag,
int *  n_deep_revise_data,
tag_t **  deep_revise_data 
)

Returns the Deep Copy Data for the revise operation

Returns
ITK_ok on success. Otherwise, it returns the error MDL0MODEL_object_deepcopy_data_cannot_be_retrieved
Parameters
conditional_element_tag(I) Conditional Element Tag which should be revised
n_deep_revise_data(O) Number of Deep Copy Data objects
deep_revise_data(OF) n_deep_revise_data Array containing the tags of the Deep Copy Data corresponding to the revise input
MDL0MODEL_API int MDL0MODEL_free_deep_revise_data ( int  n_deep_revise_data,
tag_t deep_revise_data 
)

Deletes the associated Deep Copy Data objects and frees the allocated memory. This can be called using the information from the call to the "MDL0MODEL_ask_deep_revise_data" ITK

Returns
ITK_ok, always
Parameters
n_deep_revise_data(I) Number of Deep Copy Data objects
deep_revise_data(I) Deep Copy Data objects of the revise input
MDL0MODEL_API int MDL0MODEL_get_impacted_welds ( int  n_design_element_objects,
const tag_t design_element_objects,
tag_t  configuration_context,
int *  n_impacted_welds,
tag_t **  impacted_welds,
tag_t **  ret_design_element_objects 
)

Retrieves configured impacted welds for input design elements.

Returns
Parameters
n_design_element_objects(I) Number of Design Element objects
design_element_objects(I) n_design_element_objects Array containing the tags of the Design Element objects
configuration_context(I) Configuration context
n_impacted_welds(O) Count of impacted weld objects
impacted_welds(OF) n_impacted_welds Array containing the tags of the impacted weld objects
ret_design_element_objects(OF) n_impacted_welds Array containing the tags of the input Design Element objects
MDL0MODEL_API int MDL0MODEL_query_related_objects ( int  n_source_objects,
const tag_t source_objects,
tag_t  configuration_context,
const char *  relation_type_name,
const char *  other_side_object_type_name,
const char *  attribute_name,
int  attribute_type,
const char *  attribute_value,
logical  query_primaries,
logical  return_relations,
int *  n_related_objects,
tag_t **  related_objects,
tag_t **  ret_source_objects,
tag_t **  relation_objects 
)

Retrieves configured related objects by traversing copy-stable relations.

Returns
Parameters
n_source_objects(I) Number of source objects
source_objects(I) n_source_objects Array containing the tags of the source objects
configuration_context(I) Configuration context
relation_type_name(I) Relation name for the relationship between input source objects and output related objects. If not specified, then all relations will be considered
other_side_object_type_name(I) The type of related objects to be queried for the given relation. If not specified, all related objects for the given relation name are queried
attribute_name(I) Attribute name of the relation to be filtered
attribute_type(I) Attribute type of the relation to be filtered
attribute_value(I) Attribute value of the relation to be filtered
query_primaries(I) A boolean flag to set the direction of navigation across the relation while fetching the related objects
return_relations(I) Flag to specify if the relation objects should be returned in response
n_related_objects(O) Count of related objects
related_objects(OF) n_related_objects Array containing the tags of the related objects
ret_source_objects(OF) n_related_objects Array containing the tags of the input source objects
relation_objects(OF) n_related_objects Array containing the tags of the relation objects when return_relations is set TRUE else Array containing 0 objects
MDL0MODEL_API int MDL0MODEL_revise_object ( tag_t  conditional_element_tag,
tag_t  revise_input,
int  n_deep_revise_data,
const tag_t deep_revise_data,
tag_t new_element_revision 
)

Revises a Conditional Element

Returns
ITK_ok on success. Otherwise, it returns the error MDLOMODEL_object_has_no_status
Parameters
conditional_element_tag(I) Conditional Element Tag which should be revised
revise_input(I) Revise Input Descriptor of Conditional Element
n_deep_revise_data(I) Number of Deep Copy Data objects
deep_revise_data(I) Deep Copy Data objects of the revise input
new_element_revision(O) Newly revised Conditional Element Tag