PK_PARTITION_make_pmark_o_t

struct PK_PARTITION_make_pmark_o_s
    {
    int                       o_t_version;       --- structure version
    PK_LOGICAL_t              want_attrib_mod;   --- return entities modified
                                                 --- indirectly by attributes
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_new_entities; --- return new entities
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_mod_entities; --- return modified entities
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_del_entities; --- return deleted entities
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_logged_mod;   --- return entities modified
                                                 --- by logged changes only
                                                 --- (PK_LOGICAL_false)
    PK_CLASS_array_t          new_entities_classes;
                                                 --- classes of returned new
                                                 --- entities (NULL, 0)
    PK_CLASS_array_t          mod_entities_classes;
                                                 --- classes of returned mod
                                                 --- entities (NULL, 0)
    PK_CLASS_array_t          del_entities_classes;
                                                 --- classes of returned del
                                                 --- entities (NULL, 0)
    PK_PMARK_t                original_pmark;    --- pmark from clone span
                                                 --- (PK_PMARK_null)
    };
typedef struct PK_PARTITION_make_pmark_o_s PK_PARTITION_make_pmark_o_t;


This structure contains optional arguments for PK_PARTITION_make_pmark_2.

Used in:

PK_PARTITION_make_pmark_2

Description of fields:


'want_attrib_mod'   Controls the type of modifications that are reported in the
                    return argument 'mod_entities' array. If an entity is only
                    indirectly modified by changes to attributes, it will only
                    be reported if this option is set to PK_LOGICAL_true.
                    The default is PK_LOGICAL_true.

                    If you want to use 'mod_entities' to track changes in a
                    model, we recommend that you leave 'want_attrib_mod' at
                    its default of PK_LOGICAL_true. Setting it to
                    PK_LOGICAL_false can suppress entities that have also been
                    modified by modelling changes.


'want_new_entities' Whether to return an array of created entities instead
                    of NULL. The default is PK_LOGICAL_true.


'want_mod_entities' Whether to return an array of modified entities instead
                    of NULL. The default is PK_LOGICAL_true.


'want_del_entities' Whether to return an array of deleted entities instead
                    of NULL. The default is PK_LOGICAL_true.


'want_logged_mod'   Controls the type of modifications that are reported in the
                    return argument 'mod_entities' array. If this option is set
                    to PK_LOGICAL_true, only those entities that have been
                    modified by a modelling change will be reported.
                    The default is PK_LOGICAL_false.


'new_entities_classes'
                    If not empty, restrict the returned new entities to
                    those matching the classes in this array.
                    The default is an empty array.


'mod_entities_classes'
                    If not empty, restrict the returned modified entities to
                    those matching the classes in this array.
                    The default is an empty array.


'del_entities_classes'
                    If not empty, restrict the returned deleted entities to
                    those matching the classes in this array.
                    The default is an empty array.


'original_pmark'    If 'original_pmark' is not PK_PMARK_null then the
                    application is declaring that the partition in its
                    current state is equivalent to the state it was in when
                    the 'original_pmark' was created. The pmark returned by
                    PK_PARTITION_make_pmark_2 is then the clone pmark
                    corresponding to this 'original_pmark'.


For the options 'new_entities_classes', 'mod_entities_classes' and
'del_entities_classes', the arrays are allowed to contain PK_CLASS_entity
and any of its subclasses, except PK_CLASS_attdef. If any superclasses are
specified in an array then their subclasses must not also be specified.