Server
API Reference Guide
Product Documentation:

Visualization Server
Documentation Home
List of all members | Public Member Functions
IlsArrayRelation Class Reference

Base class for array relations. More...

#include <ilserver/model.h>

Inheritance diagram for IlsArrayRelation:
IlsOptionalRelation IlsDynamicArrayRelation IlsOwnsFixedArray< OwnerType, OwnedType, size > IlsUsesFixedArray< UserType, UsedType, size > IlsOwnsDynamicArray< OwnerType, OwnedType > IlsUsesDynamicArray< UserType, UsedType >

Public Member Functions

int * getAdded (int &s)
 During a notification phase, this member function returns an arrays of indices corresponding to the elements that have been added to the array since the last notification phase. More...
 
IlsBoolean isModified ()
 During a notification phase, this member function returns IlsTrue if the array-relation has been modified since the last notification phase. More...
 
- Public Member Functions inherited from IlsOptionalRelation
IlsRelationId getIdentifier () const
 
IlsBoolean isMandatory ()
 Returns IlsTrue if the relation is mandatory. Otherwise, it returns IlsFalse. When a relation is mandatory, a cut applied to the target of the relation is propagated to its origin. By default, the function returns IlsFalse for n-ary relations and IlsTrue for unary relations.
 

Detailed Description

Base class for array relations.

Member Function Documentation

◆ getAdded()

int* IlsArrayRelation::getAdded ( int &  s)

During a notification phase, this member function returns an arrays of indices corresponding to the elements that have been added to the array since the last notification phase.

It returns an empty array if no element has been added to the array. The argument accepts the size of the array as a return value. You must explicitly destroy this array when you no longer need it. To do so, use delete with square brackets [].

◆ isModified()

IlsBoolean IlsArrayRelation::isModified ( )

During a notification phase, this member function returns IlsTrue if the array-relation has been modified since the last notification phase.

The function returns IlsTrue if one of these events has occurred:

  • Re-allocation of the array-relation;
  • Addition of one or more elements to the array-relation;
  • Removal of one or more elements from the array-relation.