JanaStoreView

JanaStoreView — A store query interface

Synopsis




                    JanaStoreView;
void                jana_store_view_get_range           (JanaStoreView *self,
                                                         JanaTime **start,
                                                         JanaTime **end);
void                jana_store_view_set_range           (JanaStoreView *self,
                                                         JanaTime *start,
                                                         JanaTime *end);
void                jana_store_view_start               (JanaStoreView *self);
JanaStore*          jana_store_view_get_store           (JanaStoreView *self);

Object Hierarchy


  GInterface
   +----JanaStoreView

Signals


  "added"                                          : Run Last
  "modified"                                       : Run Last
  "removed"                                        : Run Last

Description

JanaStoreView is the interface for a query, or 'view' on a JanaStore. A store view has functions to query a particular time range of components.

Details

JanaStoreView

typedef struct _JanaStoreView JanaStoreView;

The JanaStoreView struct contains only private data.

jana_store_view_get_range ()

void                jana_store_view_get_range           (JanaStoreView *self,
                                                         JanaTime **start,
                                                         JanaTime **end);

Retrieves the range over which this JanaStoreView is set to span. A NULL start or end indicate an unbounded range.

self : A JanaStoreView
start : Return location for the start of the view range, or NULL
end : Return location for the end of the view range, or NULL

jana_store_view_set_range ()

void                jana_store_view_set_range           (JanaStoreView *self,
                                                         JanaTime *start,
                                                         JanaTime *end);

Sets the range for the JanaStoreView to span. A NULL parameter indicates that that end of the range should be unbounded (i.e. extended infinitely into the past or future).

self : A JanaStoreView
start : The start of the range, or NULL
end : The end of the range, or NULL

jana_store_view_start ()

void                jana_store_view_start               (JanaStoreView *self);

Starts the view. No signals will be emitted prior to calling this function.

self : A JanaStoreView

jana_store_view_get_store ()

JanaStore*          jana_store_view_get_store           (JanaStoreView *self);

Retrieves the JanaStore that this view operates on.

self : A JanaStoreView
Returns : The JanaStore that this view operates on.

Signal Details

The "added" signal

void                user_function                      (JanaStoreView *store_view,
                                                        gpointer       components,
                                                        gpointer       user_data)       : Run Last

The ::added signal is emitted when new components become visible in the scope of the store view.

store_view : the store view that received the signal
components : A list of JanaComponents
user_data : user data set when the signal handler was connected.

The "modified" signal

void                user_function                      (JanaStoreView *store_view,
                                                        gpointer       components,
                                                        gpointer       user_data)       : Run Last

The ::modified signal is emitted when components that were previously in view have been modified in some way.

store_view : the store view that received the signal
components : A list of JanaComponents
user_data : user data set when the signal handler was connected.

The "removed" signal

void                user_function                      (JanaStoreView *store_view,
                                                        gpointer       uids,
                                                        gpointer       user_data)       : Run Last

The ::removed signal is emitted when components that were previously in view have been removed from the underling JanaStore.

store_view : the store view that received the signal
uids : A list of uids
user_data : user data set when the signal handler was connected.

See Also

JanaStore