iRel Interface

Rel

class itaps.iRel.Rel([options])

Return a new Rel object with any implementation-specific options defined in options.

Parameters:

• options – Implementation-specific options string

createPair(left, left_type[, left_status], right, right_type[, right_status])

Create a new relation pair between two ITAPS interfaces.

Parameters:

• left – The interface on the left half of the pair
• left_type – The relation Type for the first interface
• left_status – The relation Status for the first interface
• right – The interface on the right half of the pair
• right_type – The relation Type for the second interface
• right_status – The relation Status for the second interface

Returns:

The newly-created relation pair

destroyPair(pair)

Destroy a relation pair.

Parameters:

• pair – The relation pair to be destroyed

findPairs(interface)

Find all relation pairs that contain the specified interface.

Parameters:

• interface – The interface to search for

Returns:

A list of relation pairs

Pair

class itaps.iRel.Pair

An association between two ITAPS interfaces allowing their entities or sets to be related to one another.

instance

Return the Rel instance from which this pair was created.

left

Return the PairSide corresponding to the left half of this relation pair.

right

Return the PairSide corresponding to the right half of this relation pair.

relate(left, right)

Relate two elements (entities or sets) to one another. If left and right are arrays, relate the elements pairwise.

Parameters:

• left – Entity or EntitySet from the left half of the relation pair
• right – Entity or EntitySet from the right half of the relation pair

inferAllRelations()

Infer the relations between elements (entities or sets) in the interfaces defined by this relation pair. The criteria used to infer these relations depends on the interfaces in the pair, the iRel implementation, and the source of the data in those interfaces.

PairSide

class itaps.iRel.PairSide

One half of a Pair, corresponding to a given side of the relation pair.

side[entities]

Get the related entities for an entity, entity set, or array of entities.

side[entities1] = entities2

Set the related entities for an entity, entity set, or array of entities to entities2.

del side[entities]

Remove the relation data for an entity, entity set, or array of entities.

instance

Return the instance corresponding to the this side of the relation pair.

type

Return the relation Type of the this side of the relation pair.

status

Return the relation Status of the this side of the relation pair.

get(entities[, out])

Get the entity/set related to the specified element. If the input is an array of elements, this function returns pairwise relations.

Parameters:

• entities – Entity or EntitySet from the left half of the relation pair

Returns:

The related entity

inferRelations(entities)

Infer the relations corresponding to the supplied element(s) (entities or sets) in the interfaces defined by this relation pair. The criteria used to infer these relations depends on the interfaces in the pair, the iRel implementation, and the source of the data in those interfaces.

Parameters:

• entities – Entity or EntitySet from the left half of the relation pair

Enumerations

class itaps.iRel.Type

An enumeration of relation types corresponding to iRel_RelationType.

entity

The relation relates entities on this side to/from the other side.

set

The relation relates sets on this side to/from the other side.

both

The relation relates sets on this side to/from the other side, and entities to (not from) the other side.

class itaps.iRel.Status

An enumeration of relation statuses corresponding to iRel_RelationStatus.

active

The relation on this side is active and up to date.

inactive

The relation on this side is inactive, and may be out of date.

notexist

The relation on this side is not stored.