Bpp/Data_structure
Data_template
C++
 
 
DESCRIPTION
 

This module provides data templates designed to be carried by a data structure.

 
SOURCE FILES
 

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

 
PARENT MODULE
 

This module is part of Bpp/Data_structure.

 
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.

  • <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

 
ERRORS
 

Here are listed the errors that are supported or generated by the module. To use one of them, you do not have to specify the namespace of the module.

  • erNegativeFlowCapacity
    A flow capacity is negative.

 
CLASSES
 

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

 
clCommodityData
 
 
Declaration

class clCommodityData

 
Description

Represents a commodity in a graph (i.e. a quantity that must be routed from a source node to a target node), designed to be carried by a data structure.

 
Attributes
  • tyCardinal source()
    The number that identifies the source node. Reading and writing access.

  • tyCardinal target()
    The number that identifies the target node. Reading and writing access.

  • tyReal quantity()
    The quantity that must be routed. Reading and writing access.

 
Methods
 
clCostData
 
 
Declaration

class clCostData

 
Description

Represents a cost, designed to be carried by a data structure.

 
Attributes
  • tyReal cost()
    The cost value. Reading and writing access.

 
Methods
 
clFlowData
 
 
Declaration

class clFlowData

 
Description

Represents a flow, designed to be carried by a data structure.

 
Attributes
  • tyReal maximum()
    Maximum flow. Reading and writing access.

  • tyReal flow()
    Resolved flow. Reading and writing access.

 
Methods
 
clGenericData
 
 
Declaration

class clGenericData

 
Description

Represents the data carried by a data structure in a generic way. All the data is stored in a single string of characters.

 
Attributes
  • clString characters()
    The generic data. Reading and writing access.

 
Methods
 
clLengthData
 
 
Declaration

class clLengthData

 
Description

Represents a length, designed to be carried by a data structure.

 
Attributes
  • tyReal length()
    The length value. Reading and writing access.

 
Methods
 
clLocationData
 
 
Declaration

class clLocationData

 
Description

Represents a location (i.e. coordinates in a 3D environment), designed to be carried by a data structure.

 
Attributes
  • tyReal x()
    The X coordinate. Reading and writing access.

  • tyReal y()
    The Y coordinate. Reading and writing access.

  • tyReal z()
    The Z coordinate. Reading and writing access.

 
Methods
 
clNoData
 
 
Declaration

class clNoData

 
Description

Represents nothing, designed to be carried by a data structure.

 
Methods
 
clRealData
 
 
Declaration

class clRealData

 
Description

Represents a real value, designed to be carried by a data structure.

 
Attributes
  • tyReal value()
    The value. Reading and writing access.

 
Methods
 
clRealIntervalData
 
 
Declaration

class clRealIntervalData

 
Description

Represents an interval of real values and a real value in this interval, designed to be carried by a data structure.

 
Attributes
  • tyReal minimum()
    Minimum value of the interval. Reading and writing access.

  • tyReal maximum()
    Maximum value of the interval. Reading and writing access.

  • tyReal value()
    Value in this interval. Reading and writing access.

 
Methods
 
clStandardData
 
 
Declaration

template <class prData> class clStandardData

 
Description

Represents a standard data (like an integer, a character...), designed to be carried by a data structure.

 
Attributes
  • prData value()
    The value. 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).