Package: Transforms

## Documentation

Table of Contents
Class Inheritance Tree

## Index

Package: Transforms

- Goto spec source

# Description

    package Alog.Transforms is

Abstract package Transforms. Provides methods used by all Alog transforms.

# Classes

### Instance (abstract)

- Goto declaration in source
- Goto full declaration in source

    type Instance is abstract tagged limited private;

#### Immediate Children:

Alog.Transforms.Casing.Instance
Alog.Transforms.Class

#### Primitive operations:

Setup

- To API doc
- To spec

Teardown

- To API doc
- To spec

Transform_Message

- To API doc
- To spec

Abstract type transform instance. All tranforms in the Alog framework must implement this type.

# Types

### Class

- Goto declaration in source

    subtype Class is Instance'Class;

### Handle

- Goto declaration in source

    type Handle is access Class;

# Subprograms & Entries

### =

- Goto spec in source

    function "=" (Left: Handle;Right: Handle) return Boolean;

Equal function.

### Set_Name

- Goto spec in source

    procedure Set_Name (Transform: in out Class;Name:        String);

Set transform name.

### Get_Name

- Goto spec in source

    function Get_Name (Transform: Class) return String;

Get transform name.

### Transform_Message (abstract)

- Goto spec in source

    function Transform_Message (Transform: Instance;Level: Log_Level;Msg: String) return String is abstract;

Transform message with specified log level.

### Setup

- Goto spec in source

    procedure Setup (Transform: in out Instance) is null;

Each transform must provide a Setup-procedure. These procedures are called by logger instances when attaching Transforms. All needed operations prior to transforming log messages should be done here.

### Teardown

- Goto spec in source

    procedure Teardown (Transform: in out Instance) is null;

Each transform must provide a Teardown-procedure. These procedures are called by logger instances when detaching Transforms or when the logger object gets out of scope.