KnowledgeInterfaces Interface CATIVisitor

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIVisitor

Interface dedicated to implementing a visitor pattern.
Role: The visitor performs operations on objects submitted by a provider (cf. Design Patterns by the Gang of Four, Addison-Wesley, chapter 5 "Visitor").
The provider scans recursively a structure and submit objects to the visitor. The visitor returns a result code indicating if the scan should continue or not.
It provides performance improvements over the method consisting in creating a list of interesting elements and then performing operations on them.

BOA information: this interface CAN be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index

o SpecialDataNeeded()

In some cases, special data is needed to be visited.

o Visit(CATBaseUnknown*)

Operates on the submitted object and returns a continuation code.

o VisitPublisherForRecursion(CATIParmPublisher_var&)

For optimization purpose.

Methods

In some cases, special data is needed to be visited.

Returns:

NULL if no special data is to be visited, else a list of strings containing format specifications (these formats have to be discussed between callers and providers)

Operates on the submitted object and returns a continuation code.

Parameters:

iInstance

Object to be performed on.

Returns:

S_OK to continue the scan, E_FAIL to stop.

For optimization purpose. if VisitChildren is called with recursive argument, allows to control if given publisher is to be visited

Parameters:

publisher

the tested publisher

Returns:

S_OK if the publisher is to be visited, E_FAIL else

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.