VisuPairSet

VisuPairSet — a base class for all loadable representation of VisuData objects.

Functions

Properties

VisuData * data Read
GArray * pairs Read

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── VisuPairSet

Description

This object is storing dynamically all the VisuPair objects that exist for a given VisuData object.

Functions

visu_pair_set_new ()

VisuPairSet *
visu_pair_set_new ();

Define an object to handle all possible VisuPair for a given VisuNodeArray.

Returns

a new VisuPairSet object.

[transfer full]

Since: 3.8


visu_pair_set_setModel ()

gboolean
visu_pair_set_setModel (VisuPairSet *set,
                        VisuData *nodes);

Binds nodes population and unit to set .

Parameters

set

a VisuPairSet object.

 

nodes

a VisuData object.

 

Returns

TRUE if model is actually changed.

Since: 3.8


visu_pair_set_getNthPair ()

VisuPair *
visu_pair_set_getNthPair (VisuPairSet *set,
                          guint pos);

Retrieve the nth VisuPair stored in set .

Parameters

set

a VisuPairSet object.

 

pos

an integer.

 

Returns

the nth VisuPair in set .

[transfer none]

Since: 3.8


visu_pair_set_get ()

VisuPair *
visu_pair_set_get (VisuPairSet *set,
                   const VisuElement *ele1,
                   const VisuElement *ele2);

Retrieve the VisuPair linking ele1 and ele2 as stroed in set if it exists, or NULL if not.

Parameters

set

a VisuPairSet object.

 

ele1

a VisuElement object.

 

ele2

a VisuElement object.

 

Returns

the VisuPair stored in set linking ele1 and ele2 .

[transfer none]

Since: 3.8


visu_pair_set_getFromLink ()

VisuPair *
visu_pair_set_getFromLink (VisuPairSet *set,
                           const VisuPairLink *link);

Retrieve the VisuPair stored in set that contains link , or NULL if none.

Parameters

set

a VisuPairSet object.

 

link

a VisuPairLink object.

 

Returns

the VisuPair stored in set containing link .

[transfer none]

Since: 3.8


visu_pair_set_iter_new ()

void
visu_pair_set_iter_new (VisuPairSet *set,
                        VisuPairSetIter *iter,
                        gboolean all);

Creates an iterator over all the VisuPairLink of a set of VisuPair. If all is FALSE, only visible VisuPairLink, see visu_pair_link_setDrawn(), are iterated on.

Parameters

set

a VisuPairSet object.

 

iter

a VisuPairSetIter location.

[out caller-allocates]

all

a boolean.

 

Since: 3.8


visu_pair_set_iter_next ()

void
visu_pair_set_iter_next (VisuPairSetIter *iter);

Iterates to the next VisuPairLink.

Parameters

iter

a VisuPairSetIter object.

 

Since: 3.8


VisuPairPoolForeachFunc ()

void
(*VisuPairPoolForeachFunc) (VisuPair *pair,
                            gpointer user_data);

Prototype of functions called with the foreach method apply to each pairs.

Parameters

pair

a VisuPair object.

 

user_data

some user defined data.

 

visu_pair_pool_foreach ()

void
visu_pair_pool_foreach (VisuPairPoolForeachFunc whatToDo,
                        gpointer user_data);

The way VisuPair are stored in V_Sim is private and could changed between version. This method is used to apply some method each pairs.

Parameters

whatToDo

a VisuPairSetForeachFunc() method ;.

[scope call]

user_data

some user defined data.

 

visu_pair_pool_finalize ()

void
visu_pair_pool_finalize ();

Free all associated memory.

[skip]

Since: 3.8


visu_pair_pool_readLinkFromLabel ()

gboolean
visu_pair_pool_readLinkFromLabel (const gchar *label,
                                  VisuPairLink **data,
                                  gchar **errorMessage);

Reads label and parses it to detect the definition of a VisuPairLink. This pair link is added to the VisuPair from the pool.

Parameters

label

a string.

 

data

a VisuPairLink location.

[out callee-allocates]

errorMessage

a string location.

[out callee-allocates]

Returns

TRUE on success.

Since: 3.8

Types and Values

struct VisuPairSetIter

struct VisuPairSetIter {
  VisuPairSet *set;
  VisuPair *pair;
  VisuPairLink *link;
};

Iterator structure to run over all VisuPairLink of a given set of VisuPair.

Members

VisuPairSet *set;

the VisuPairSet this iterator is based on.

 

VisuPair *pair;

the current VisuPair.

 

VisuPairLink *link;

the current VisuPairLink.

 

Property Details

The “data” property

  “data”                     VisuData *

data elements come from.

Flags: Read


The “pairs” property

  “pairs”                    GArray *

set of pairs.

Flags: Read

Signal Details

The “links-changed” signal

void
user_function (VisuPairSet *set,
               VisuPair    *pair,
               gpointer     user_data)

Gets emitted when any of the VisuPair of set has a change (addition or removal) in its list of VisuPairLink.

Parameters

set

the object which emits the signal ;

 

pair

the VisuPair that has changing links.

[type VisuPair]

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8