ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros
ITEM Messages

Macros

#define ITEM_baseline_rev_msg   "ITEM_baseline_rev"
 
#define ITEM_copy_rev_msg   "ITEM_copy_rev"
 
#define ITEM_copy_rev_to_existing_msg   "ITEM_copy_rev_to_existing"
 
#define ITEM_create_from_rev_msg   "ITEM_create_from_rev"
 
#define ITEM_create_msg   "ITEM_create"
 
#define ITEM_create_rev_msg   "ITEM_create_rev"
 
#define ITEM_deep_copy_msg   "ITEM_deep_copy"
 

Detailed Description

Macro Definition Documentation

#define ITEM_baseline_rev_msg   "ITEM_baseline_rev"

Produce a new baseline for the given existing revision.

Parameters
tag_tbase_rev_tag
constchar* baseline_rev_id
constchar* description
constchar* rel_proc_name
constchar* job_name
constchar* job_description
logicaldryrun
tag_t*new_rev
int*deepCopiedObjectCount
tag_t**deepCopiedObjects

Definition at line 126 of file item_msg.h.

#define ITEM_copy_rev_msg   "ITEM_copy_rev"

Produce a new working revision based on the given existing revision.

Parameters
tag_tsource_rev
constchar* rev_id
tag_t*new_rev
tag_titem_rev_master_form

Definition at line 85 of file item_msg.h.

#define ITEM_copy_rev_to_existing_msg   "ITEM_copy_rev_to_existing"

Produce a new Revision from an existing ItemRevision based on the preference Allow_copy_as_rev. If this preference is set to true or 1, this will copy the contents of one Item revision below an item to a newly created Item Revision below another existing item, else it will create a Brand new Item.

Parameters
tag_trevTag Tag of the Parent Item Revision
constchar* new_rev_id The RevId of the Revision to be created.
constchar* name Name of the new revision
constchar* description The description of new revision
tag_titem_tag Tag of the existing Item
tag_t*new_rev Tag of the Newly created Revision.
tag_titem_rev_master_form Tag of Newly created Item Revision Master form

Definition at line 142 of file item_msg.h.

#define ITEM_create_from_rev_msg   "ITEM_create_from_rev"

Create a new item based on an existing item revision.

Parameters
tag_told_item
tag_told_rev
constchar* new_item_id
constchar* new_rev_id
tag_t*new_item
tag_t*new_rev
constchar* new_name
constchar* new_description
tag_titem_master_form
tag_titem_rev_master_form

Definition at line 65 of file item_msg.h.

#define ITEM_create_msg   "ITEM_create"

Create a new item with initial working revision.

Parameters
constchar* item_id
constchar* item_name
constchar* type_name
constchar* rev_id
tag_t*new_item
tag_t*new_rev
tag_titem_master_form
tag_titem_rev_master_form

Definition at line 49 of file item_msg.h.

#define ITEM_create_rev_msg   "ITEM_create_rev"

Create a new (empty) working revision for an existing item.

Parameters
tag_titem
constchar* rev_id
tag_t*new_rev
tag_titem_rev_master_form

Definition at line 75 of file item_msg.h.

#define ITEM_deep_copy_msg   "ITEM_deep_copy"

This is for reading the Site Preference Rule set for DeepCopy operation and based on the copy rules set for each of the Item revision attachments, the copy operation will be carried out as

copy_as_object A brand new object will be created from the existing attachment object. The newly created object has distinct behavior than its parent.
copy_as_referenceA symbolic link will be created between the attachment of the parent item revision and newly created Item revision. If the attachment of parent changes the newly created Item rev's corresponding attachment also changes
no_copy The Attachment will be detached from the newly created ITem Revision
Parameters
tag_tnew_rev The Tag of the newly created Item Revision
char*operation Whether the operation is Save As/Revise
tag_tparent_rev The Tag of the Item Revision over which Save As/Revise operation will be performed
intcopyCount Number of deep copy rules set
ITEM_deepcopy_info_t*copyInfo Deep Copy Rule Information
int*count Number of Datasets attached
tag_t**copied_objects The tags of the deep copied attachments

Definition at line 110 of file item_msg.h.