ANNO_addFilter

- add or change annotation filtering

Synopsis

#include <$OV_HEADER/ecs/ANNO/ANNO.h>
int32 ANNO_addFilter
  (
    ANNO_ConnectionId conId,
    const char *circuitName,
    const char *nodeName
  );
  

Description

This function filters annotation requests based on the originating node name and/or circuit name. If the circuitName or nodeName parameters are equal to zero, there will be no filtering on circuit name or node name. To disable all filtering on the given connection, set both to be zero. This will enable all requests to be received.

The circuit name is the name the circuit was given when it was loaded into the engine. This is not to be confused with the filename the circuit was saved as or copied to.

The node name is the short node name. Eg if a circuit contained the node mcirc_001_b_module.tmpcompound.tmpnode.annonode, the nodeName parameter in ANNO_addFilter would be just the last part, annonode.

Parameters

ANNO_ConnectionId conId

The connection that filtering will be added to.

const char *circuitName

If zero, there is no circuitName filtering on this connection. If non-zero, only requests originating from circuits with the same name will be passed to the annotation server.

const char *nodeName

If zero, there is no node filtering on this connection. If nonzero, only requests originating from nodes with the same name will be passed to the annotation server.

Returns

ECS_SUCCESS

Succeeded.

ANNO_NOT_INTIALISED

ANNO_stackInit has not been called.

ANNO_BAD_CONNECTION

ConId isn't an open annotation connection.