Documentation Set for Swarm 2.2
Prev | Reference IV. Objectbase Library | Next

# ProbeMap

## Name

ProbeMap -- A container class for Probes used to specify the contents of a ProbeDisplay.

## Description

A ProbeMap is a Map-type collection of Probes. They are used to gather several Probes, who usually have a common referent, into a single bundle. For example, all the instance variables of a ModelSwarm might be gathered into a single ProbeMap. Each ProbeMap is then installed into the global ProbeLibrary.

## Protocols adopted by ProbeMap

SwarmObject ProbeConfig CREATABLE

## Methods

### Phase: Creating

- - setProbedObject: object

- - setProbedClass: (Class)class
  The setProbedClass: method sets the class of the object that the set of probes that constitute the probe map points at. This message must be sent before createEnd.

### Phase: Using

- - clone: (id <Zone>)aZone
  The clone: method returns a clone of the probe map. If the initial probe map created by Library Generation or by the default version of Object generation, the probe map should be cloned prior to making changes to it to avoid having the changes affect the other potential users of the probe map.

- - (id <Index>)begin: (id <Zone>)aZone
  The begin: method returns an iterator (index) over the ProbeMap. This index is used in the exact same way any Map index is used.

- - dropProbeMap: (id <ProbeMap>)aProbeMap
  The dropProbeMap: method is used to drop a probe from a probe map. It is equivalent to callling dropProbeForVariable for each variable name present in the ProbeMap being dropped, followed by a call to dropProbeForMessage for each message name present in the ProbeMap being dropped.

- - (void)dropProbeForMessage: (const char *)aMessage
  The dropProbeForMessage: method is used to drop a Probe from the ProbeMap. No class verification takes place since the probe is dropped based on its messageName, not its actual id value.

- - (void)dropProbeForVariable: (const char *)aVariable
  The dropProbeForVariable: method is used to drop a Probe from the ProbeMap. No class verification takes place since the probe is dropped based on its variableName, not its actual id value.

- - addProbeMap: (id <ProbeMap>)aProbeMap
  The addProbeMap: method is used to tailor the contents of a ProbeMap by performing "set inclusion" with another ProbeMap. The typing is verified prior to inclusion.

- - addProbe: (id <Probe>)aProbe
  The addProbe: method adds a probe to the contents of the ProbeMap. The ProbeMap will always make sure that the probedClass of the Probe being added corresponds to its own probedClass.

- - (Class)getProbedClass
  The getProbedClass method returns the class of the object that the set of probes that constitute the probe map points at.

- - (unsigned)getCount
  The getCount method returns the number of probes in the ProbeMap.

Prev | Home | Next
ProbeLibrary | Up | Swarm