ps.h File Reference

#include <ps/ps_errors.h>
#include <ps/ps_tokens.h>
#include <unidefs.h>
#include <ps/libps_exports.h>
#include <ps/libps_undef.h>

Go to the source code of this file.

Functions
PS_API int	PS_add_optional_item (tag_t parent, tag_t occurrence, tag_t child_item, tag_t opt_item, tag_t opt_rev, tag_t opt_view, tag_t *optlist)
PS_API int	PS_add_related_substitutes (int n_items, tag_t *occurrences, tag_t *sub_items, tag_t *substitute_set)
PS_API int	PS_ask_latest_option_rev (tag_t variant, tag_t *variantRev)
PS_API int	PS_ask_occurrence_client_data (tag_t parent, tag_t occurrence, const char *attr_name, tag_t *client_data)
PS_API int	PS_bvr_ask_default_next_seq_no (tag_t bvr, tag_t child_item, char **seq_no)
PS_API int	PS_change_to_replace (tag_t oldBvr, tag_t oldOccTag, tag_t newBvr, tag_t newOccTag)
PS_API int	PS_has_form_attached_to_ug_dataset (tag_t item_rev, logical *result)
PS_API int	PS_list_optional_items (tag_t parent, tag_t occurrence, tag_t child_item, int *count, tag_t **opt_items)
PS_API int	PS_list_related_substitutes (tag_t occurrence, tag_t sub_item, int *n_items, tag_t **related_occs, tag_t **related_items)
PS_API int	PS_remove_optional_item (tag_t parent, tag_t occurrence, tag_t child_item, tag_t opt_item, tag_t opt_rev, tag_t opt_view)
PS_API int	PS_remove_related_substitutes (int n_items, tag_t *occurrences, tag_t *sub_items)
PS_API int	PS_set_occurrence_client_data (tag_t parent, tag_t occurrence, const char *attr_name, tag_t client_data)
PS_API int	PS_system_default_bom_view_name (tag_t item, tag_t view_type, char **name)
PS_API int	PS_system_default_bvr_name (tag_t item_revision, tag_t view_type, char **name)
PS_API int	PS_variant_expression_new_persistent_id (char **variant_expression_persistent_id)
PS View Type Functions
PS_API int	PS_view_type_ask_valid_occurrence_types (tag_t type_tag, tag_t **valid_occs, int *count)
PS_API int	PS_view_type_ask_default_occurrence_type (tag_t view_type_tag, tag_t *occ_type_tag)
PS_API int	PS_ask_view_type_name (tag_t view_type, char **type_name)
PS_API int	PS_find_view_type (const char *type_name, tag_t *view_type)
PS_API int	PS_view_type_extent (int *n_types, tag_t **view_types)
PS_API int	PS_get_displayable_view_types (int *n_types, tag_t **view_types)
PS_API int	PS_ask_default_view_type (tag_t *view_type)
PS Occurrence Types
Common Return Values: PS_duplicate - An occurrence type by the same name already exists in the database. PS_invalid_occ_type - Invalid occurrence type tag specified.
PS_API int	PS_find_occurrence_type (const char *type_name, tag_t *occ_type)
PS_API int	PS_occurrence_type_extent (int *n_types, tag_t **occ_types)
PS_API int	PS_ask_occurrence_type_name (tag_t occ_type, char **type_name)
PS BOM View Functions
PS_API int	PS_create_bom_view (tag_t view_type, const char *view_name, const char *view_desc, tag_t parent_item, tag_t *bom_view)
PS_API int	PS_default_bom_view_name (tag_t item, tag_t view_type, char **name)
PS_API int	PS_delete_bom_view (tag_t bom_view)
PS_API int	PS_ask_item_of_bom_view (tag_t bom_view, tag_t *item)
PS_API int	PS_ask_bom_view_type (tag_t bom_view, tag_t *view_type)
PS_API int	PS_set_bom_view_type (tag_t bom_view, tag_t view_type)
PS_API int	PS_list_bvrs_of_bom_view (tag_t bom_view, int *n_bvrs, tag_t **bvrs)
BOM View Revision Functions
PS_API int	PS_create_bvr (tag_t bom_view, const char *revision_name, const char *revision_desc, logical precise, tag_t parent_ir, tag_t *bvr)
PS_API int	PS_revise_bvr (tag_t source_bvr, const char *revision_name, const char *revision_desc, tag_t parent_ir, tag_t *new_bvr)
PS_API int	PS_copy_bvr (tag_t source_bvr, tag_t bom_view, const char *revision_name, const char *revision_desc, tag_t parent_ir, tag_t *new_bvr)
PS_API int	PS_bvr_translate_mvl (tag_t bvr, int n_modules, char **from_modules, char **to_modules)
PS_API int	PS_default_bvr_name (tag_t item_revision, tag_t view_type, char **name)
PS_API int	PS_delete_bvr (tag_t bvr)
PS_API int	PS_ask_bom_view_of_bvr (tag_t bvr, tag_t *bom_view)
PS_API int	PS_ask_is_bvr_precise (tag_t bvr, logical *is_precise)
PS_API int	PS_set_bvr_precise (tag_t bvr)
PS_API int	PS_set_bvr_imprecise (tag_t bvr)
PS_API int	PS_list_occurrences_of_bvr (tag_t bvr, int *n_occurrences, tag_t **occurrences)
PS_API int	PS_list_owning_revs_of_bvr (tag_t bvr, int *n_item_revs, tag_t **item_revs)
PS_API int	PS_ask_is_bvr_shared (tag_t bvr, logical *is_shared)
PS_API int	PS_ask_struct_modified_date (tag_t bvr, date_t *struct_dlm)
PS_API int	PS_ask_legacy_transform_factor (tag_t bvr, double *legacy_factor)
PS_API int	PS_set_legacy_transform_factor (tag_t bvr, double legacy_factor)
PS_API int	PS_remove_legacy_transform_factor (tag_t bvr)
PS Occurrence Sequencing
PS_API int	PS_add_predecessor (tag_t bvr, tag_t occ, tag_t predecessor)
PS_API int	PS_remove_predecessor (tag_t bvr, tag_t occ, tag_t predecessor)
PS_API int	PS_list_predecessors (tag_t bvr, tag_t occ, int *count, tag_t **pred)
PS Occurrence Functions
PS_API int	PS_create_occurrences (tag_t parent, tag_t child_item, tag_t child_bom_view, int n_occurrences, tag_t **occurrences)
PS_API int	PS_create_occurrences_with_occ_type (tag_t parent, tag_t child_item, tag_t child_bom_view, int n_occurrences, tag_t occType, tag_t **occurrences)
PS_API int	PS_create_occurrences_tag_validation (tag_t parent, tag_t child_item, int n_occurrences)
PS_API int	PS_verify_occurrence_conditions (tag_t parent_rev_tag, tag_t child_rev_tag)
PS_API int	PS_delete_occurrence (tag_t parent, tag_t occurrence)
PS_API int	PS_set_occurrence_type (tag_t parent, tag_t occurrence, const char *occTypeString)
PS_API int	PS_ask_occurrence_type (tag_t parent, tag_t occurrence, char **occTypeString)
PS_API int	PS_ask_occurrence_child (tag_t parent, tag_t occurrence, tag_t *child_item, tag_t *child_bom_view)
PS_API int	PS_set_occurrence_child (tag_t parent, tag_t occurrence, tag_t child_item, tag_t child_bom_view)
PS_API int	PS_ask_seq_no (tag_t parent, tag_t occurrence, char **seq_no)
PS_API int	PS_set_seq_no (tag_t parent, tag_t occurrence, const char *seq_no)
PS_API int	PS_ask_occurrence_name (tag_t parent, tag_t occurrence, char **occurrence_name)
PS_API int	PS_set_occurrence_name (tag_t parent, tag_t occurrence, const char *occurrence_name)
PS_API int	PS_ask_occ_clone_stable_uid (tag_t parent, tag_t occurrence, char **clone_stable_uid)
PS_API int	PS_ask_occurrence_ref_designator (tag_t parentBVR, tag_t occThread, char **refDesignator)
PS_API int	PS_set_occurrence_ref_designator (tag_t parentBVR, tag_t occThread, const char *refDesignator)
PS_API int	PS_ask_occurrence_qty (tag_t parent, tag_t occurrence, double *qty)
PS_API int	PS_set_occurrence_qty (tag_t parent, tag_t occurrence, double qty)
PS_API int	PS_ask_occurrence_flag (tag_t parent, tag_t occurrence, int flag, logical *is_set)
PS_API int	PS_set_occurrence_flag (tag_t parent, tag_t occurrence, int flag)
PS_API int	PS_clear_occurrence_flag (tag_t parent, tag_t occurrence, int flag)
PS_API int	PS_ask_transform (tag_t parent, tag_t occurrence, double **transform)
PS_API int	PS_ask_plmxml_transform (tag_t parent, tag_t occurrence, double **transform)
PS_API int	PS_set_plmxml_transform (tag_t parent, tag_t occurrence, double *transform)
PS_API int	PS_convert_legacy_transform (tag_t parent, tag_t occurrence, double **ext_transform)
PS_API int	PS_move_occurrence_to (tag_t parent, tag_t occurrence, int new_index)
PS_API int	PS_move_occurrence_up (tag_t parent, tag_t occurrence)
PS_API int	PS_move_occurrence_down (tag_t parent, tag_t occurrence)
PS_API int	PS_list_occurrence_notes (tag_t parent, tag_t occurrence, int *n_notes, tag_t **note_types)
PS_API int	PS_ask_occurrence_note_text (tag_t parent, tag_t occurrence, tag_t note_type, char **text)
PS_API int	PS_set_occurrence_note_text (tag_t parent, tag_t occurrence, tag_t note_type, const char *text)
PS_API int	PS_delete_occurrence_note (tag_t parent, tag_t occurrence, tag_t note_type)
PS Substitutes Functions
PS_API int	PS_list_substitutes (tag_t parent, tag_t occurrence, int *n_substitutes, tag_t **sub_items, tag_t **sub_views)
PS_API int	PS_ask_has_substitutes (tag_t parent, tag_t occurrence, logical *has_substitutes)
PS_API int	PS_add_substitute (tag_t parent, tag_t occurrence, tag_t child_item, tag_t child_bom_view)
PS_API int	PS_delete_substitute (tag_t parent, tag_t occurrence, tag_t child_item)
PS_API int	PS_prefer_substitute (tag_t parent, tag_t occurrence, tag_t child_item, logical *is_temporary)
PS Variants
The variant data is a pointer to a variant_expression block (see bom.h for routines to manipulate it) An occurrence may have either variant data or substitutes, but not both. It is an error to attempt to set the one if the occurrence currently has the other defined
PS_API int	PS_ask_has_variant_data (tag_t parent, tag_t occurrence, logical *has_variant_data)
PS_API int	PS_ask_variant_data (tag_t parent, tag_t occurrence, tag_t *variant_expression_block)
PS_API int	PS_set_variant_data (tag_t parent, tag_t occurrence, tag_t variant_expression_block)
PS_API int	PS_load_variant_expr_blocks (int n_blocks, tag_t *variant_expression_blocks, logical force_sub_expr_check)
PS_API int	PS_load_variant_exprs (int n_exprs, tag_t *variant_expressions, logical force_sub_expr_check)
PS Object Functions
PS_API int	PS_define_client_data (int ps_class, const char *attr_name, tag_t ref_class, int property)
PS_API int	PS_delete_client_data_defn (int ps_class, const char *attr_name)
PS_API int	PS_describe_client_data (int ps_class, const char *attr_name, tag_t *ref_class, int *property)
PS_API int	PS_ask_client_data (tag_t instance, const char *attr_name, tag_t *client_data)
PS_API int	PS_set_client_data (tag_t instance, const char *attr_name, tag_t client_data)
PS Note Type Functions
PS_API int	PS_note_type_extent (int *n_note_types, tag_t **note_types)
PS_API int	PS_find_note_type (const char *name, tag_t *note_type)
PS_API int	PS_ask_note_type_name (tag_t note_type, char **name)
PS_API int	PS_ask_note_type_description (tag_t note_type, char **description)
PS_API int	PS_ask_note_type_default_value (tag_t note_type, char **default_value)
PS Where Used Functions
PS_API int	PS_where_used_all (tag_t target_tag, int n_levels, int *n_parents, int **levels, tag_t **parents)
PS_API int	PS_where_used_precise (tag_t target_tag, int n_levels, int *n_parents, int **levels, tag_t **parents)
PS_API int	PS_where_used_configured (tag_t target_tag, tag_t rev_rule, int n_levels, int *n_parents, int **levels, tag_t **parents)
PS Unified Occurrence Effecivity Functions
PS_API int	PS_occ_eff_create (tag_t bvr, tag_t occ, tag_t *eff)
PS_API int	PS_occ_eff_add_eff (tag_t bvr, tag_t occ, tag_t eff)
PS_API int	PS_occ_eff_remove_eff (tag_t bvr, tag_t occ, tag_t eff)
PS_API int	PS_occ_eff_set_id (tag_t bvr, tag_t occ, tag_t eff, const char *id)
PS_API int	PS_occ_eff_set_protection (tag_t bvr, tag_t occ, tag_t eff, logical protection)
PS_API int	PS_occ_eff_set_enditem (tag_t bvr, tag_t occ, tag_t eff, tag_t enditem)
PS_API int	PS_occ_eff_set_enditemrev (tag_t bvr, tag_t occ, tag_t eff, tag_t enditemrev)
PS_API int	PS_occ_eff_set_unit_range (tag_t bvr, tag_t occ, tag_t eff, const char *range_text, logical append)
PS_API int	PS_occ_eff_set_units (tag_t bvr, tag_t occ, tag_t eff, int n_units, int *start_end_values, int open_ended_or_stock_out, logical append)
PS_API int	PS_occ_eff_set_date_range (tag_t bvr, tag_t occ, tag_t eff, const char *range_text, logical append)
PS_API int	PS_occ_eff_set_dates (tag_t bvr, tag_t occ, tag_t eff, int n_dates, date_t *start_end_values, int open_ended_or_stock_out, logical append)
PS_API int	PS_occ_eff_ask_effs (tag_t bvr, tag_t occ, int *n_effs, tag_t **effs)
PS_API int	PS_occ_eff_ask_id (tag_t bvr, tag_t occ, tag_t eff, char **id)
PS_API int	PS_occ_eff_ask_protection (tag_t bvr, tag_t occ, tag_t eff, logical *protection)
PS_API int	PS_occ_eff_ask_enditem (tag_t bvr, tag_t occ, tag_t eff, tag_t *enditem)
PS_API int	PS_occ_eff_ask_enditemrev (tag_t bvr, tag_t occ, tag_t eff, tag_t *enditemrev)
PS_API int	PS_occ_eff_ask_range_type (tag_t bvr, tag_t occ, tag_t eff, int *range_type)
PS_API int	PS_occ_eff_ask_unit_range (tag_t bvr, tag_t occ, tag_t eff, char **range_text)
PS_API int	PS_occ_eff_ask_units (tag_t bvr, tag_t occ, tag_t eff, int *n_units, int **start_end_values, int *open_ended_or_stock_out)
PS_API int	PS_occ_eff_ask_date_range (tag_t bvr, tag_t occ, tag_t eff, char **range_text)
PS_API int	PS_occ_eff_ask_dates (tag_t bvr, tag_t occ, tag_t eff, int *n_dates, date_t **start_end_values, int *open_ended_or_stock_out)

Detailed Description

File description: Function prototypes for the Product Structure (PS) ITK.

Filename: ps.h
Module  : ps

==================================================================================================== Date Name Description of Change

28-Jul-2010 Dhinakaran.V Added API PS_ask_latest_option_rev ( project 011529)

$HISTORY$

Definition in file ps.h.