GATLoader.h File Reference

Header file for the GATLoader class. More...

#include "GATRegistry.h"
#include "GATTable.h"

Include dependency graph for GATLoader.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define _GATLOADER_H_ 1

Typedefs

typedef GATLoader_S * GATLoader

Functions

void GATLoader_Destroy (GATLoader *this)

GATLoader_Destroy The GATLoader destructor.

GATResult GATLoader_LoadAdaptor (GATLoader this, GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, const char *path, const char *name, const char *nickname)

GATLoader_LoadAdaptor Loads a given adaptor.

Variables

GATLoader GATLoader_Create (void)

Detailed Description

Header file for the GATLoader class.

A GATLoader is responsible for loading and maintaining a list of adaptors.

Date:: Thu Sep 18 2003

Version:

Header:: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATLoader.h,v 1.9 2004/04/09 12:29:18 hartmutkaiser Exp

Use, modification and distribution is subject to the Gridlab Software License. (See accompanying file GLlicense.txt or copy at http://www.gridlab.org/GLlicense.txt)

Definition in file GATLoader.h.

Define Documentation

#define _GATLOADER_H_ 1

Definition at line 21 of file GATLoader.h.

Typedef Documentation

typedef struct GATLoader_S* GATLoader

Definition at line 23 of file GATLoader.h.

Function Documentation

void GATLoader_Destroy ( GATLoader * this )

GATLoader_Destroy The GATLoader destructor.
This is the destructor for GATLoader objects.
Parameters:

this An old GATLoader

Definition at line 106 of file GATLoader.c.
References AdaptorInstance_Destroy(), and AdaptorInstance::next.
Referenced by GATSelf_Destroy().

GATResult GATLoader_LoadAdaptor ( GATLoader this,

GATContext error_context,

GATRegistry registry,

GATTable_const system_config,

GATTable_const instance_config,

const char * path,

const char * name,

const char * nickname

)

GATLoader_LoadAdaptor Loads a given adaptor.
Given a path, load the adaptor pointed to there, invoking its registration function and passing that both a system and an instance configuration tables. Each adaptor may be given a nickname, which is otherwise extracted from the file part of the path. All nicknames must be unique.
Parameters:

this The loader object.

registry The registry the adaptor should register its CPIs with.

system_config The system configuration table.

instance_config The configuration table for this instance.

path The path to the adaptor file.

name The name of the adaptor.

nickname The name the loader should know this adaptor instance as.

Returns:
An error code.

Definition at line 147 of file GATLoader.c.
References AdaptorInstance_Create(), AdaptorInstance_Destroy(), GAT_CREATE_STATUS, GAT_CREATE_STATUS_MSG, GAT_CURRENT_STATUS, GAT_DUPLICATE_ADAPTOR, GAT_FAILED_TO_LOAD_ADAPTOR, GAT_MEMORYFAILURE, GAT_RETURN_STATUS, GAT_SUCCEEDED, GAT_USES_STATUS, GATTable_const, AdaptorInstance::handle, LoadAdaptor(), AdaptorInstance::next, AdaptorInstance::nickname, and AdaptorInstance::path.
Referenced by Load().

Variable Documentation

GATLoader GATLoader_Create(void)