Bpp/Simulation
Object
C++
 
 
DESCRIPTION
 

This module provides basic classes to represent objects in a simulation.

 
SOURCE FILES
 

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

 
PARENT MODULE
 

This module is part of Bpp/Simulation.

 
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>

  • <jirk/bpp/simulation/visualcomponent.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/simulation/simulator.hpp>

  • <jirk/java/lang/string.hpp>

  • <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 jirk::bpp::simulation::jaVisualComponent clVisualComponent
    Visual component representing a simulation object.

 
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.

  • erInvalidPath
    The path used to move the object is invalid.

 
CLASSES
 

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

 
clObject
 
 
Declaration

class clObject

 
Description

Represents an object in a simulation. Every class that instantiates objects to be managed within a simulation should inherit from this class.

 
Methods
 
clPhysicalObject
 
 
Declaration

class clPhysicalObject : public clObject

 
Description

Represents a physical object, i.e. with a location and a visual representation. It is an abstract class.

 
Types
  • type std_set(clStillObject *) clStillChildS
    Type of the list of still children of the object.

  • type std_set(clMobileObject *) clMobileChildS
    Type of the list of mobile children of the object.

  • type clPhysicalObject * clParentPointer
    Type of the pointer to the parent of the object.

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

  • clParentPointer parent()
    Parent of the component, i.e. the physical object inside, or upon, which the component is located. Reading access only.

  • tyBoolean deep()
    Indicates if the object is deep, i.e. if it has an inside representation. Reading access only.

  • clStillChildS stillChildren()
    Still children of the component, i.e. still objects located on its layout. Reading access only.

  • clMobileChildS mobileChildren()
    Mobile children of the component, i.e. mobile objects temporarily located on its layout. Reading access only.

  • clVisualComponent view()
    Visual representation of the object. Reading and writing access.

  • clString status()
    String describing the status of the object. Reading access only.

 
Methods
 
clStillObject
 
 
Declaration

class clStillObject : public clPhysicalObject

 
Description

Represents a still physical object.

 
Methods
 
clMobileObject
 
 
Declaration

class clMobileObject : public clPhysicalObject

 
Description

Represents a mobile physical object.

 
Attributes
  • tyCardinal arrivalDate()
    Date the object arrived at its last location. Reading access only.

  • tyCardinal travelTime()
    If the object is located on a path, time it needs to travel along the path. Reading access only.

 
Methods
 
clPath
 
 
Declaration

class clPath : public clStillObject

 
Description

Represents a path between two still objects.

 
Types
  • type clStillObject * tyExtremityPointer
    Type of a pointer to the extremities of the path.

 
Attributes
  • tyExtremityPointer source()
    Still object that is the source of the path. Reading access only.

  • tyExtremityPointer target()
    Still object that is the target of the path. Reading access only.

 
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).