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

Collaboration Context

Modules

Collaboration Context Setup Function

Collaboration Context creation Functions

Functions for CCObject

Functions for StructureContext

Functions for ConfigurationContext

Functions for SC Type Data

Functions for copying objects

Accountability check functions

Collaboration Context related

Type related

Define macro for StructureContent relation subtype

Define Documentation

#define COLLABCTX_CCObject_class_name_c   "CCObject"

Definition at line 30 of file collabctx.h.

#define COLLABCTX_ccobject_type_name_c   "CCObject"

Definition at line 47 of file collabctx.h.

#define COLLABCTX_composition_structure_type_name_c   "CompositionContext"

Definition at line 54 of file collabctx.h.

#define COLLABCTX_configuration_context_type_name_c   "ConfigurationContext"

Definition at line 55 of file collabctx.h.

#define COLLABCTX_ConfigurationContext_class_name_c   "ConfigurationContext"

Definition at line 36 of file collabctx.h.

#define COLLABCTX_content_rel_any_stype   0

Definition at line 63 of file collabctx.h.

#define COLLABCTX_content_rel_background   ( 1 << 0 )

Definition at line 64 of file collabctx.h.

#define COLLABCTX_content_rel_target   ( 1 << 1 )

Definition at line 65 of file collabctx.h.

#define COLLABCTX_context_lov_name   "Context Names"

Definition at line 35 of file collabctx.h.

#define COLLABCTX_context_relation_name   "IMAN_CCContext"

Definition at line 32 of file collabctx.h.

#define COLLABCTX_factory_structure_type_name_c   "MEPlantContext"

Definition at line 50 of file collabctx.h.

#define COLLABCTX_me_ccobject_type_name_c   "MECollaborationContext"

Definition at line 48 of file collabctx.h.

#define COLLABCTX_private_structure_type_name_c   "PrivateContext"

Definition at line 53 of file collabctx.h.

#define COLLABCTX_PrivateContext_class_name_c   "PrivateContext"

Definition at line 39 of file collabctx.h.

#define COLLABCTX_process_structure_type_name_c   "MEProcessContext"

Definition at line 51 of file collabctx.h.

#define COLLABCTX_product_structure_type_name_c   "MEProductContext"

Definition at line 49 of file collabctx.h.

#define COLLABCTX_ref_context_relation_name   "IMAN_CCReferenceContext"

Definition at line 38 of file collabctx.h.

#define COLLABCTX_resource_structure_type_name_c   "MEResourceContext"

Definition at line 52 of file collabctx.h.

#define COLLABCTX_SCTypeData_class_name_c   "SCTypeData"

Definition at line 37 of file collabctx.h.

#define COLLABCTX_SCTypeData_relation_name   "IMAN_SCTypeData"

Definition at line 40 of file collabctx.h.

#define COLLABCTX_sctypedata_type_name_c   "SCTypeData"

Definition at line 56 of file collabctx.h.

#define COLLABCTX_structure_content_relation_name   "IMAN_StructureContent"

Definition at line 33 of file collabctx.h.

#define COLLABCTX_StructureContext_class_name_c   "StructureContext"

Definition at line 31 of file collabctx.h.

#define COLLABCTX_study_relation_name   "IMAN_CCStudy"

Definition at line 34 of file collabctx.h.

Function Documentation

COLLABCTX_API int COLLABCTX_acctability_check ( 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 
)

Preforms an accountability check

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) The possible source context line (in case the check is done when in-context mode is on)
bomCtxtLineTag  (I) The possible target context line (in case the check is done when in-context mode is on)
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.

COLLABCTX_API int COLLABCTX_add_structure_context ( tag_t  cc,
tag_t  context 
)

Add StructureContext to CC.

Parameters:
cc  (I) The CCObject
context  (I) The StructureContext to be added

COLLABCTX_API int COLLABCTX_alignment_check ( tag_t  source_line,
tag_t  target_line,
int *  count,
tag_t **  source_lines,
tag_t **  target_lines,
int **  n_mismatched_properties,
int **  mismatched_properties,
int *  n_properties,
char ***  properties 
)

find and return aligned occurrences whose data mismatches

Parameters:
source_line  (I) The scope line to start the alignment check
target_line  (I) The scope line of the target BOM to start alignment check
count  (O) The number of mismatched pairs
source_lines  (OF) count Tags of source lines of the mismatches
target_lines  (OF) count Tags of target lines of the mismatches
n_mismatched_properties  (OF) count Number of the mismatching properties of each mismatched pair (value ranges from 1 to n_properties)
mismatched_properties  (OF) count Indices of mismatched properties
n_properties  (O) The number of properties used
properties  (OF) n_properties Properties used for the check

COLLABCTX_API int COLLABCTX_ask_structure_contexts ( tag_t  cc,
int *  number,
tag_t **  contexts 
)

Ask all StructureContext.

Parameters:
cc  (I) The CCObject
number  (O) Number of StructureContexts
contexts  (OF) The StructureContexts tag list

COLLABCTX_API int COLLABCTX_ask_working_context ( tag_t  cc,
tag_t *  context 
)

Ask the working StructureContext (also called Study).

Note:
There will be only one working context
Parameters:
cc  (I) The CCObject
context  (O) Tag of the Working StructureContext

COLLABCTX_API int COLLABCTX_ccobj_ask_config_context ( tag_t  cc,
tag_t *  config 
)

Ask the ConfigurationContext used by this CCObject.

Parameters:
cc  (I) The CCObject
config  (O) Tag of the ConfigurationContext

COLLABCTX_API int COLLABCTX_ccobj_set_config_context ( tag_t  cc,
tag_t  config 
)

Set ConfigurationContext to the CCObject.

Parameters:
cc  (I) The CCObject
config  (I) The ConfigurationContext to be set

COLLABCTX_API int COLLABCTX_clear_acctability_check ( tag_t *  windows,
int  num_win 
)

After a run of accountability check each line assigned with a color property This method resets this property in all the lines

Parameters:
windows  (I) List of windows on which to clear check results.
num_win  (I) Number of windows in the list.

COLLABCTX_API int COLLABCTX_configuration_ask_arrangement ( tag_t  context,
tag_t *  arrangement 
)

Ask for the AssemblyArrangement in ConfigurationContext.

Parameters:
context  (I) The ConfigurationContext
arrangement  (O) Tag of the AssemblyArrangement

COLLABCTX_API int COLLABCTX_configuration_ask_closurerule ( tag_t  context,
tag_t *  rule 
)

Ask the ClosureRule stored in ConfigurationContext.

Parameters:
context  (I) The ConfigurationContext
rule  (O) Tag of the Closure rule

COLLABCTX_API int COLLABCTX_configuration_ask_revisionrule ( tag_t  context,
tag_t *  rule 
)

Ask the RevisionRule.

Parameters:
context  (I) The ConfigurationContext
rule  (O) Tag of the revision rule

COLLABCTX_API int COLLABCTX_configuration_ask_variantrule ( tag_t  context,
tag_t *  rule 
)

Ask the VaraintRule.

Parameters:
context  (I) The ConfigurationContext
rule  (O) Tag of the Variant rule

COLLABCTX_API int COLLABCTX_configuration_chg_arrangement ( tag_t  context,
tag_t  arrangement 
)

Temporarily change AssemblyArragement in ConfigurationContext.

Note:
It will not be saved
Parameters:
context  (I) The ConfigurationContext
arrangement  (I) The new AssemblyArrangement

COLLABCTX_API int COLLABCTX_configuration_chg_closurerule ( tag_t  context,
tag_t  rule 
)

Temporarily change ClosureRule to ConfigurationContext.

Note:
It will not be saved
Parameters:
context  (I) The ConfigurationContext
rule  (I) The new Closure rule

COLLABCTX_API int COLLABCTX_configuration_chg_revisionrule ( tag_t  context,
tag_t  rule 
)

Temporarily change RevisionRule to ConfigurationContext.

Note:
It will not be saved
Parameters:
context  (I) The ConfigurationContext
rule  (I) The new Revision rule

COLLABCTX_API int COLLABCTX_configuration_chg_variantrule ( tag_t  context,
tag_t  rule 
)

Temporarily change VariantRule to ConfigurationContext.

Note:
It will not be saved
Parameters:
context  (I) The ConfigurationContext
rule  (I) The new Variant rule

COLLABCTX_API int COLLABCTX_configuration_set_arrangement ( tag_t  context,
tag_t  arrangement 
)

Set AssemblyArragement in ConfigurationContext.

Parameters:
context  (I) The ConfigurationContext
arrangement  (I) The AssemblyArrangement to be set

COLLABCTX_API int COLLABCTX_configuration_set_closurerule ( tag_t  context,
tag_t  rule 
)

Set ClosureRule to ConfigurationContext. It will be saved as well.

Parameters:
context  (I) The ConfigurationContext
rule  (I) The closure rule to be set

COLLABCTX_API int COLLABCTX_configuration_set_revisionrule ( tag_t  context,
tag_t  rule 
)

Set RevisionRule to ConfigurationContext. If Rule is a run time revision rule, we will:

  1. if context already has private rule, replace the entries of the private rule
  2. otherwise, clone the input rule and save it as private rule to the context.
Parameters:
context  (I) The ConfigurationContext
rule  (I) The Revision rule to be set

COLLABCTX_API int COLLABCTX_configuration_set_variantrule ( tag_t  context,
tag_t  rule 
)

Set BOMVariantRule to ConfigurationContext.

  1. If BOMVariantRule has set_variant_rule and not modified, just set set_variant_rule to context
  2. If BOMVariantRule has set_variant_rule and modified, save set_variant_rule and set set_variant_rule
  3. If BOMVariantRule does not have set_variant_rule, create set_variant_rule and set to context

Note:
We take BOMVariantRule, not VariantRule itself !!
Parameters:
context  (I) The ConfigurationContext
rule  (I) The BOMVariantRule to be set

COLLABCTX_API int COLLABCTX_context_add_content ( tag_t  context,
tag_t  comp,
int  subType 
)

Add component to StructureContext.

Note:
The component can be Item/ItemRevision/AppearanceGroup.
Parameters:
context  (I) The StructureContext
comp  (I) The component to be added
subType  (I) Subtype such as COLLABCTX_content_rel_background

COLLABCTX_API int COLLABCTX_context_ask_config_context ( tag_t  context,
tag_t *  config 
)

Ask the ConfigurationContext used by this StructureContext.

Parameters:
context  (I) The StructureContext
config  (O) Tag of the ConfigurationContext

COLLABCTX_API int COLLABCTX_context_ask_contents ( tag_t  context,
int *  number,
tag_t **  contents,
int  subType 
)

Ask all the components used by this StructureContext.

Parameters:
context  (I) StructureContext
number  (O) Number of contexts
contents  (OF) number Contexts list
subType  (I) SubType of the content relation such as background/target, etc.

COLLABCTX_API int COLLABCTX_context_is_composition ( tag_t  context,
logical *  isComp 
)

Ask whether StructureContext is a composition.

Parameters:
context  (I) The StructureContext
isComp  (O) Whether or not it is a composition

COLLABCTX_API int COLLABCTX_context_remove_content ( tag_t  context,
tag_t  comp 
)

Remove component from StructureContext.

Note:
The component can be Item/ItemRevision/AppearanceGroup.
Parameters:
context  (I) The StructureContext
comp  (I) The component to be removed

COLLABCTX_API int COLLABCTX_context_set_config_context ( tag_t  context,
tag_t  config 
)

Set ConfigurationContext to the StructureContext.

Parameters:
context  (I) The StructureContext
config  (I) The ConfigurationContext to be set

COLLABCTX_API int COLLABCTX_context_single_end_item ( tag_t  context,
logical *  isSingle 
)

Ask whether StructureContext only allow an End Item.

Parameters:
context  (I) The StructureContext
isSingle  (O) Whether or not it allows only single End Item

COLLABCTX_API int COLLABCTX_copy_ccobject ( tag_t  baseCC,
const char *  name,
const char *  desc,
tag_t *  newCC 
)

Copy the CCObject and its relations

Parameters:
baseCC  (I) The CC to copy
name  (I) Name for new object if different
desc  (I) Description for new object if different
newCC  (O) Tag of new object

COLLABCTX_API int COLLABCTX_copy_configuration_context ( tag_t  baseConfig,
const char *  name,
const char *  desc,
tag_t *  newConfig 
)

Copy the ConfigurationContext and its relations

Parameters:
baseConfig  (I) The ConfigurationContext to copy
name  (I) Name for new object if different
desc  (I) Description for new object if different
newConfig  (O) Tag of new object

COLLABCTX_API int COLLABCTX_copy_structure_context ( tag_t  baseSC,
const char *  name,
const char *  desc,
tag_t *  newSC 
)

Copy the StructureContext and its relations

Parameters:
baseSC  (I) The StructureContext to copy
name  (I) Name for new object if different
desc  (I) Description for new object if different
newSC  (O) Tag of new object

COLLABCTX_API int COLLABCTX_create_ccobject ( const char *  type,
const char *  name,
const char *  desc,
tag_t *  cc 
)

Creates the CCObject instance.

Parameters:
type  (I) Type name - can be empty - will take default type
name  (I) Name of the CCObject
desc  (I) Description of the CCObject
cc  (O) Tag of CCObject instance

COLLABCTX_API int COLLABCTX_create_config_context_based_on_ref ( const char *  type,
const char *  name,
const char *  desc,
tag_t *  ref_obj_tag,
tag_t *  context 
)

Create ConfigurationContext instance based on reference

Parameters:
type  (I) Type name - can be empty - will take default type
name  (I) Name of the ConfigurationContext
desc  (I) Description of the ConfigurationContext
ref_obj_tag  (I) Tag of reference object
context  (O) Tag of ConfigurationContext instance

COLLABCTX_API int COLLABCTX_create_configuration_context ( const char *  type,
const char *  name,
const char *  desc,
tag_t *  rule 
)

Create ConfigurationContext instance.

Parameters:
type  (I) Type name - can be empty - will take default type
name  (I) Name of the ConfigurationContext
desc  (I) Description of the ConfigurationContext
rule  (O) Tag of ConfigurationContext instance

COLLABCTX_API int COLLABCTX_create_structure_context ( const char *  type,
const char *  name,
const char *  desc,
tag_t *  context 
)

Create the StructureContext instance.

Parameters:
type  (I) Type name - can be empty - will take default type
name  (I) Name of the StructureContext
desc  (I) Description of the StructureContext
context  (O) Tag of StructureContext instance

COLLABCTX_API int COLLABCTX_init_module (  ) 

Initializes the Collaboration Context module. This function must be called before using any other Collaboration Context module functions. This function will be called by the standard ITK startup code. The ITK programmer can ignore this function.

Note:
A second call is ignored.

COLLABCTX_API int COLLABCTX_remove_structure_context ( tag_t  cc,
tag_t  context 
)

Remove StructureContext from CC.

Parameters:
cc  (I) The CCObject
context  (I) The StructureContext to be removed

COLLABCTX_API int COLLABCTX_sctype_ask_is_composition ( tag_t  scType,
logical *  is_comp 
)

Ask whether structure context type is composition

Parameters:
scType  (I) The Structurecontext type
is_comp  (O) Whether or not it is a composition

COLLABCTX_API int COLLABCTX_sctype_ask_single_end_item ( tag_t  scType,
logical *  is_single 
)

Ask whether structure context type allows only one end item

Parameters:
scType  (I) The Structurecontext type
is_single  (O) Whether or not it allows only single End Item

COLLABCTX_API int COLLABCTX_set_working_context ( tag_t  cc,
tag_t  context 
)

Set the working StructureContext

Parameters:
cc  (I) The CCObject
context  (I) The StructureContext to be set

COLLABCTX_API int COLLABCTX_sync_aligned_occurrences ( tag_t  source_line,
tag_t  target_line 
)

Sync alignment data

Parameters:
source_line  (I) The source line of the alignment to sync data
target_line  (I) The target line of the alignment to sync data