Bpp/Meta_model
Structure
C++
 
 
DESCRIPTION
 

This module provides a simplified meta-model for C++/Java libraries like the B++ Library.

 
SOURCE FILES
 

This section allows you to access the C++ source files of the module.

 
PARENT MODULE
 

This module is part of Bpp/Meta_model.

 
INCLUDED FILES
 

The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here.

  • <set>

  • <bpp/standard.hpp>

 
NEEDED FILES
 

The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here.

  • <bpp/modules.hpp>

 
INTEGRATED NAMESPACES
 

The namespaces listed below are integrated in this module. That means any element declared in one of those namespaces can now be directly used by or from this module.

  • standard

 
TYPES
 

Here are listed the types defined in the module. To use one of them, you have to specify the namespace of the module.

  • type std_map(clString,clModuleInformation *) clModuleInformationX
    Association of module names with module information.

  • type std_vector(clEntityInformation) clEntityInformationS
    List of entity information.

  • type std_set(clString) clFileS
    List of file names.

  • type std_map(clString,clString) clAliasX
    Association of aliases with the file name they represent.

  • type std_map(clString,clFileDependency) clFileDependencyX
    Association of file names with their dependency information.

  • type std_map(clString,clLibraryDependency) clLibraryDependencyX
    Association of library names with their dependency information.

 
CONSTANTS
 

Here are listed the constants provided by the module. To use one of them, you have to specify the namespace of the module.

  • tcString cppExtension()
    Extension of the C++ implementation source file names.

  • tcString dllExtension()
    Extension of the dynamic-link library file names.

  • tcString dllPrefix()
    Prefix of the dynamic-link library file names.

  • tcString hppExtension()
    Extension of the C++ interface source file names.

  • tcString libraryExtension()
    Extension of the static library file names.

  • tcString objectExtension()
    Extension of the object file names.

 
CLASSES
 

Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module.

 
clFileDependency
 
 
Declaration

class clFileDependency

 
Description

Contains the dependency information of a source file.

 
Attributes
  • clString alias()
    Short name of the source file (used by #include). Reading and writing access.

  • clString sourceName()
    Full name of the source file. Reading and writing access.

  • clString objectName()
    Full name of the object file associated with the source file. Reading and writing access.

  • clFileS files()
    List of the files the source file depends on. Reading and writing access.

  • tyBoolean complete()
    Indicates if the list above is complete. Reading and writing access.

  • tyBoolean isJava()
    Indicates if it's a Java file. Reading and writing access.

 
Methods
 
clLibraryDependency
 
 
Declaration

class clLibraryDependency

 
Description

Contains the dependency information of a library.

 
Attributes
  • clString name()
    Full name of the static version of the library. Reading and writing access.

  • clString dllName()
    Full name of the dynamic version of the library. Reading and writing access.

  • clString alias()
    Short name of the static version of the library. Reading and writing access.

  • clString dllAlias()
    Short name of the dynamic version of the library. Reading and writing access.

  • clFileS files()
    List of the files the library depends on. Reading and writing access.

 
Methods
 
clDependency
 
 
Declaration

class clDependency

 
Description

Represents the dependencies of files and libraries in a list of folders.

 
Attributes
  • clFileDependencyX files()
    List of files and their dependency. Reading and writing access.

  • clLibraryDependencyX libraries()
    List of libraries and their dependency. Reading and writing access.

  • clAliasX paths()
    List of the folders (containing the source files) and their alias (for the makefile). Reading and writing access.

 
Methods
 
clEntityInformation
 
 
Declaration

class clEntityInformation

 
Description

Represents the information of an entity of the meta-model.

 
Attributes
  • clString name()
    Name of the entity. Reading and writing access.

  • clString declaration()
    C++ declaration of the entity. Reading and writing access.

  • clString description()
    Description of the entity. Reading and writing access.

  • tyCardinal reference()
    HTML reference of the entity. Reading and writing access.

 
Methods
 
clModuleInformation
 
 
Declaration

class clModuleInformation

 
Description

Represents the information of a module in the meta-model.

 
Attributes
  • clString name()
    Name of the module. Reading and writing access.

  • clString path()
    Path of the module. Reading and writing access.

  • clString shortName()
    Short name of the module. Reading and writing access.

  • tyBoolean isJava()
    Indicates if the module is written in Java. Reading and writing access.

  • clString nameSpace()
    Namespace associated with the module. Reading and writing access.

  • clString parent()
    Parent module of the module. Reading and writing access.

  • clString description()
    Description of the module. Reading and writing access.

  • tyCardinal level()
    Level of the module in the modules hierarchy. Reading and writing access.

  • clString codeTargetFile()
    Name of the HTML file containing the source code of the module. Reading and writing access.

  • clString cppSourceFile()
    Name of the implementation source file of the module. Reading and writing access.

  • clString homeTargetFile()
    Name of the HTML file containing the documentation of the module. Reading and writing access.

  • clString hppSourceFile()
    Name of the interface source file of the module. Reading and writing access.

  • clString indexTargetFile()
    Name of the framed HTML file containing the documentation of the module. Reading and writing access.

  • clString menuTargetFile()
    Name of the HTML file containing the menu of the documentation of the module. Reading and writing access.

  • clChildS children()
    List of the child modules of the module. Reading and writing access.

  • clNameS includes()
    List of the files included into the interface of the module. Reading and writing access.

  • clNameS needs()
    List of the files used by the implementation of the module. Reading and writing access.

  • clNameS namespaces()
    List of the namespaces integrated into the module. Reading and writing access.

  • clEntityS aliases()
    List of the aliases used by the module. Reading and writing access.

  • clEntityS macrocommands()
    List of the macrocommands defined by the module. Reading and writing access.

  • clEntityS types()
    List of the types defined in the module. Reading and writing access.

  • clEntityS errors()
    List of the errors defined in the module. Reading and writing access.

  • clEntityS constants()
    List of the constants defined in the module. Reading and writing access.

  • clEntityS variables()
    List of the variables defined in the module. Reading and writing access.

  • clEntityS functions()
    List of the functions defined in the module. Reading and writing access.

  • clEntityS classes()
    List of the classes defined in the module. Reading and writing access.

  • clEntityS attributes()
    List of the attributes of the classes defined in the module. Reading and writing access.

  • clEntityS methods()
    List of the methods of the classes defined in the module. Reading and writing access.

  • clEntityS classTypes()
    List of the types in the classes defined in the module. Reading and writing access.

 
Methods
 
 
Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. See this license for more details (http://www.gnu.org).