Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

As-Maintained

Detailed Description

The As-Maintained (AsMaintained) module implements the As-Maintained Structure management behaviour.

Modules

Data Structures

Typedefs

Functions

Typedef Documentation

typedef struct ASMAINTAINED_physical_children_s ASMAINTAINED_physical_children_t

Function Documentation

ASMAINTAINED_API int ASMAINTAINED_apply_revision_rule ( tag_t  topLine,
tag_t  mroRevRule,
tag_t *  configuredTopLine 
)

ITK function to apply Revision Rule

Parameters:
topLine  (I) As-Maintained BOM Line
mroRevRule  (I) MRO Revision Rule
configuredTopLine  (O) Configured As-Maintained BOM Line

ASMAINTAINED_API int ASMAINTAINED_bom_compare ( tag_t *  srcLines,
int  srcLineCount,
tag_t *  tarLines,
int  tarLineCount,
int  options,
tag_t  assyCtxtLineTag,
tag_t  bomCtxtLineTag,
int *  srcRetCount,
tag_t **  srcRetTags,
int *  matRetCount,
tag_t **  matRetTags 
)

ITK function for AsMaintained BOM Compare using AbsOcc ID

Parameters:
srcLines  (I) List of lines from source window. Structures rooted by each of them will be checked.
srcLineCount  (I) Number of source lines.
tarLines  (I) List of lines from target widnow. Checked will be done over the structures under these lines only.
tarLineCount  (I) Number of target lines.
options  (I) Options of accountability check. Expected to be any combination of the following: add 1 - For source lines with "stop" marks, if to check their children. add 2 - If to check source lines at the lowest level only, as opposed to at all levels. add 4 - If to search all contextes in target, as opposed to the current active context. add 8 - If to search by absolute occurrence ID's only, as opposed to strictly by absolute occurrence objects. add 16 - If to compare a pre-define list of additional properties during the check. add 32 - If to search for target lines connected via PublishLink
assyCtxtLineTag  (I) Tag of context line
bomCtxtLineTag  (I) Tag of BOM Context Line
srcRetCount  (O) Number of source lines checked.
srcRetTags  (OF) List of source lines checked. If not interested in this output, let *srcRetCount = -1 before calling.
matRetCount  (O) Number of matched target lines
matRetTags  (OF) List of matched target lines. If not interested in this output, let *matRetCount = -1 before calling.

ASMAINTAINED_API int ASMAINTAINED_bom_compare_no_context ( tag_t  srcLine,
tag_t  tarLine,
const char *  mode_name,
int  output_to,
int *  srcRetCount,
tag_t **  srcRetTags,
int *  matRetCount,
tag_t **  matRetTags,
int *  reportLength,
char ***  report_lines 
)

ITK function for AsMaintained BOM Compare using BOM Compare Engine

Parameters:
srcLine  (I) Tag of Source Line
tarLine  (I) Tag of Target Line
mode_name  (I) BOM Comapre Mode
output_to  (I) Output to
srcRetCount  (O) Number of source lines checked.
srcRetTags  (OF) List of source lines checked.
matRetCount  (O) Number of matched target lines
matRetTags  (OF) List of matched target lines.
reportLength  (O) Number of report lines
report_lines  (OF) Report lines

ASMAINTAINED_API int ASMAINTAINED_change_physical_part_disposition ( tag_t  physPart,
tag_t  disposition,
date_t  dispStartDate,
tag_t *  dispRelation 
)

ITK function to change the physical part disposition state

Parameters:
physPart  (I) Physical Part or Physical Part Revision
disposition  (I) new disposition
dispStartDate  (I) start date for new disposition
dispRelation  (O) relation

ASMAINTAINED_API int ASMAINTAINED_create_compare_desc (  ) 

ITK function to create compare descriptor for BOM Compare

ASMAINTAINED_API int ASMAINTAINED_create_window ( tag_t *  window  ) 

ITK function to create MRO BOM Window

Parameters:
window  (O) Tag of MRO BOM Window

ASMAINTAINED_API int ASMAINTAINED_gen_phystruc ( tag_t  inLine,
GenerateAsmStructureParams *  inParam,
tag_t *  phys_rev 
)

ITK function to generate AsMaintained Structure

Parameters:
inLine  (I) Neutral BOM line
inParam  (I) Generate Asm Structure Params
phys_rev  (O) Created Physical Part Revision

ASMAINTAINED_API int ASMAINTAINED_get_all_open_usage ( tag_t  inLine,
tag_t  childPhysicalPart,
char ***  openUsages,
int *  count,
tag_t **  childBOMLine 
)

ITK function for AsMaintained Get All Open usage First parameter is AsMaintainedBOMLine

Parameters:
inLine  (I) Selected AsMaintained Line
childPhysicalPart  (I) Copied Physical Part
openUsages  (OF) List of Usage Name
count  (O) Count of Usage Name.
childBOMLine  (OF) Child NeutralBOMLine

ASMAINTAINED_API int ASMAINTAINED_get_all_open_usage_2 ( tag_t  parentPhysicalPartRevision,
tag_t  childPhysicalPart,
char ***  openUsages,
int *  count,
tag_t **  childBOMLine 
)

ITK function for AsMaintained Get All Open usage First parameter is Physical Part Revision

Parameters:
parentPhysicalPartRevision  (I) Parent Physical Part Revision
childPhysicalPart  (I) Copied Physical Part
openUsages  (OF) List of Usage Name
count  (O) Count of Usage Name.
childBOMLine  (OF) Child NeutralBOMLine

ASMAINTAINED_API int ASMAINTAINED_get_children ( tag_t  physPart,
date_t  effectiveDate,
ASMAINTAINED_physical_children_t **  children,
int *  childCount 
)

ITK function to get child Physical Parts in As-Mainatained Structure

Parameters:
physPart  (I) Physical Part or Physical Part Revision
effectiveDate  (I) Date Time (NULL allowed implies Today)
children  (OF) List of Physical Part Revisions and As-Maintained Relations
childCount  (O) Count of effective children and As-Maintained Relations

ASMAINTAINED_API int ASMAINTAINED_get_effective_physical_part_revision ( tag_t  physPart,
date_t  effectiveDate,
tag_t *  physPartRev 
)

ITK function to get effective Physical Part Revision by effective date

Parameters:
physPart  (I) Physical Part
effectiveDate  (I) Date Time (NULL implies Today)
physPartRev  (O) Effective Physical Part Revision

ASMAINTAINED_API int ASMAINTAINED_get_physical_part_parent ( tag_t  physPart,
date_t  effectiveDate,
tag_t *  parentPhysPartRev,
tag_t *  asmStrucRel 
)

ITK function to get the immediate Physical Part parent in As-Maintained Structure

Parameters:
physPart  (I) Physical Part or Physical Part Revision
effectiveDate  (I) Date Time (NULL allowed)
parentPhysPartRev  (O) Parent Physical Part Revision
asmStrucRel  (O) As-Maintained Structure Relation

ASMAINTAINED_API int ASMAINTAINED_get_root_physical_part ( tag_t  physPart,
date_t  effectiveDate,
tag_t *  rootPhysPartRev 
)

ITK function to get the Root Physical Part parent in As-Maintained Structure

Parameters:
physPart  (I) Physical Part or Physical Part Revision
effectiveDate  (I) Date Time (NULL allowed)
rootPhysPartRev  (O) Root Physical Part Revision

ASMAINTAINED_API int ASMAINTAINED_install_physical_part ( tag_t  selectedAsMaintainedLine,
tag_t  copiedPhysicalPart,
tag_t  usageBOMLineImpl,
InstallAsmPhysPartParams *  inParams,
tag_t *  asMaintainedStructure,
tag_t *  installedLineTag 
)

ITK function to install Physical Part in AsMaintained Structure

Parameters:
selectedAsMaintainedLine  (I) Selected AsMaintainedBOMLine on which installation happens
copiedPhysicalPart  (I) Child Physical Part which needs to be installed
usageBOMLineImpl  (I) BOMLine - PSOccurrence - Position on which the installation happens
inParams  (I) Dialog Input
asMaintainedStructure  (O) Create AsMaintainedStructure relation
installedLineTag  (O) Installed AsMaintainedBOMLine

ASMAINTAINED_API int ASMAINTAINED_line_ask_all_child_lines ( tag_t  bom_line,
int *  count,
tag_t **  children 
)

ITK function to get Child Lines for selected Physical BOM Line

Parameters:
bom_line  (I) Tag of BOM Line
count  (O) Count
children  (OF) Tags of Child BOM Lines

ASMAINTAINED_API int ASMAINTAINED_line_set_window_top ( tag_t  window,
tag_t  physicalPart,
tag_t  physicalPartRev,
tag_t *  topBOMLine 
)

ITK function to set top AsMaintained BOM Line in MRO BOM Window

Parameters:
window  (I) Tag of MRO BOM Window
physicalPart  (I) Tag of Physical Part
physicalPartRev  (I) Tag of Physical Part Revision
topBOMLine  (O) Tag of top BOM Line

ASMAINTAINED_API int ASMAINTAINED_maintain_physical_part_revision ( tag_t  oldPhysPartRevTag,
date_t  effectiveFromDate,
tag_t *  outPhysPartRevTag 
)

ITK function to revise As-Maintained Physical Part Revision (O) Tag of new Physical Element Revision

Parameters:
oldPhysPartRevTag  (I) Tag of Physical Part Revision to be revised
effectiveFromDate  (I) Effective From Date of new Revision

ASMAINTAINED_API int ASMAINTAINED_move_physical_part ( tag_t  physPart,
tag_t  location,
date_t  inTime,
tag_t *  relation 
)

ITK function to change Physical Part location (O) relation

Parameters:
physPart  (I) Physical Part or Physical Part Revision
location  (I) location
inTime  (I) Date to move

ASMAINTAINED_API int ASMAINTAINED_physlocationline_set_window_top ( tag_t  window,
tag_t  physicalLocation,
tag_t *  topBOMLine 
)

ITK function to set top Physical Location BOM Line in MRO BOM Window

Parameters:
window  (I) Tag of MRO BOM Window
physicalLocation  (I) Tag of Physical Location
topBOMLine  (O) Tag of top BOM Line

ASMAINTAINED_API int ASMAINTAINED_replace_physical_part ( tag_t  selectedAsMaintainedLine,
tag_t  copiedPhysicalPart,
ASMAINTAINED_uninstall_params_s *  inParams,
tag_t *  asMaintainedStructure,
tag_t *  replacedLineTag 
)

ITK function to replace Physical Part in AsMaintained Structure

Parameters:
selectedAsMaintainedLine  (I) Selected AsMaintainedBOMLine on which installation happens
copiedPhysicalPart  (I) Child Physical Part which needs to be installed
inParams  (I) Dialog Input
asMaintainedStructure  (O) Create AsMaintainedStructure relation
replacedLineTag  (O) Replaced AsMaintainedBOMLine

ASMAINTAINED_API int ASMAINTAINED_search_installable_physical_part_revisions ( tag_t  selParentPhysBOMLine,
tag_t  selectedBOMLineImpl,
int  attrCount,
char **  attributeNames,
char **  attributeValues,
SearchInstallableAsmPhysPartParams *  outParams 
)

ITK function to search installable physical part revisions

Parameters:
selParentPhysBOMLine  (I) Selected parent physical BOM line.
selectedBOMLineImpl  (I) BOMLine - PSOccurrence - Position on which the installation/replace happens.
attrCount  (I) Total number of attributes on which search will be performed.
attributeNames  (I) Attribute names for which search will be performed.
attributeValues  (I) Attribute values for which search will be performed.
outParams  (O) Output structure with all preferred/deviated/substiture/ alternamte physical part revision and respective count.

ASMAINTAINED_API int ASMAINTAINED_uninstall_physical_part ( tag_t  selectedAsMaintainedLine,
ASMAINTAINED_uninstall_params_s *  inParams,
tag_t *  replacerLine 
)

ITK function to un-install Physical Part in AsMaintained Structure

Parameters:
selectedAsMaintainedLine  (I) Selected AsMaintainedBOMLine which is uninstalled
inParams  (I) Dialog Input
replacerLine  (O) Installed AsMaintainedBOMLine (missing asmaintained bom line)