PK_PMARK_ask_entities_o_t

struct PK_PMARK_ask_entities_o_s
    {
    int                       o_t_version;       --- version number
    PK_PMARK_t                from_pmark;        --- pmark to start from
                                                 --- (PK_PMARK_null)
    PK_LOGICAL_t              want_new_entities; --- return new entities
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_mod_entities; --- return mod entities
                                                 --- (PK_LOGICAL_true)
    PK_LOGICAL_t              want_del_entities; --- return del 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)
    };
typedef struct PK_PMARK_ask_entities_o_s PK_PMARK_ask_entities_o_t;



This structure contains optional arguments for PK_PMARK_ask_entities.

Used in:

PK_PMARK_ask_entities

Description of fields:


'from_pmark'        Return entities that would be created, modified and
                    deleted if rolling from this pmark to the destination
                    pmark. If PK_PMARK_null then it will be from the current
                    state of the partition. The default is PK_PMARK_null.


'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 would be
                    modified by a modelling change will be reported. If an
                    entity would be modified in more than one pmark during the
                    roll operation, it will be reported if any individual
                    modification would be a modelling change. The default is
                    PK_LOGICAL_false.


'new_entities_classes'
                    If not empty, restrict the returned created 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.


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.