adviser

adviser

• ACE Directive*

Defines an adviser and begins an adviser block. End the block with $#endadviser

Inside the block, functions should be specified in the order as they are listed in the adviser-type definition (see the relevant header file.)

For functions that are not implemented, use $null() in place of a function.

The adviser that is created will automatically be registered and unregistered in the module code.

For more information on advisers, see http://bitbucket.org/grelminar/asss/wiki/Adviser

Valid Syntax

• $#adviser scope adviserIdOrType1
• $#adviser scope adviserIdOrType1 adviserIdOrType2

Parameters

scope

global or arena. with global, registers this adviser on load for all arenas. with arena, registers this adviser on attach to an arena.

adviserIdOrType1

either the struct type (for example: Appk) or the adviser identifier (for example: A_PPK)

this parameter expects typenames of the form Afoo or identifiers of the form A_FOO.

if of neither form, this directive will assume that it is a typename

adviserIdOrType2

(Optional)

if the struct type is specified for adviserIdOrType1, then this is the adviser identifier.

if the adviser identifier is specified for adviserIdOrType1, then this is the struct type.

if adviserIdOrType1 defaulted from not using the standard naming conventions, and adviserIdOrType2 is not provided, it will default to A_FOO, where FOO is the uppercase representation of the typename given in adviserIdOrType1