This module provides basic classes to represent objects in a simulation. This section allows you to access the C++ source files of the module. This module is part of Bpp/Simulation . 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. 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. 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. Here are listed the types defined in the module. To use one of them, you have to specify the namespace of the module. 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. Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module. class clObject
Represents an object in a simulation. Every class that instantiates objects to be managed within a simulation should inherit from this class. class clPhysicalObject : public clObject
Represents a physical object, i.e. with a location and a visual representation. It is an abstract class. 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.
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.
public_property virtual tyReal relativeX(void) const Returns the X coordinate of the relative position of the object in the layout of its parent. Abstract method.
public_property virtual tyReal relativeY(void) const Returns the Y coordinate of the relative position of the object in the layout of its parent. Abstract method.
inline clPhysicalObject::clPhysicalObject(simulationSimulator::clSimulator & agSimulator,clAbstractPool * agPool,tyBoolean agDeep,tcString agName) Builds a physical object in a simulator. It is possible to create a deep object (default is not). A name can also be given to the object.
inline clPhysicalObject::~clPhysicalObject(void) Destructs the object.
property void clPhysicalObject::updateStatus(void) Updates the status of the object. Private method.
property void clPhysicalObject::updateView(tyPointer agInspected) Updates the visual representation of the object. A pointer to the object that is actually inspected by the graphical interface must be provided. Private method.
property tyReal clPhysicalObject::absoluteX(void) const Returns the X coordinate of the absolute position of the object in the layout.
property tyReal clPhysicalObject::absoluteY(void) const Returns the Y coordinate of the absolute position of the object in the layout.
property void clPhysicalObject::addChild(clStillObject * agObject) Adds a still child, i.e. a still object, on the layout of the object.
property void clPhysicalObject::addChild(clMobileObject * agObject) Adds a mobile child, i.e. a mobile object, on the layout of the object.
property void clPhysicalObject::removeChild(clStillObject * agObject) Removes a still child, i.e. a still object, from the layout of the object.
property void clPhysicalObject::removeChild(clMobileObject * agObject) Removes a mobile child, i.e. a mobile object, from the layout of the object.
property void clPhysicalObject::updateView(void) Updates the visual representation of the object.
class clStillObject : public clPhysicalObject
Represents a still physical object. class clMobileObject : public clPhysicalObject
Represents a mobile physical object. 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.
class clPath : public clStillObject
Represents a path between two still objects. | | 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). |
|
| |