The following manoeuvre types with their configuration parameters are processed: TC Type: Config. Properties: Generating code for class CC_ManoeuvreFactory in file .h The following telecommand types with their configuration parameters are processed: TC Type: Config. Properties: Generating code for class CC_TelecommandFactory in file .h The following telemetry packet types with their configuration parameters are processed: TC Type: Config. Properties: Generating code for class CC_TelemetryPacketFactory in file .h // // Copyright 2004 P&P Software GmbH - All Rights Reserved // // .h // // This file was automatically generated by an XSL program // #ifndef H #define H #include "GeneralInclude/ForwardDeclarations.h" #include "GeneralInclude/BasicTypes.h" #include "Base/CC_RootObject.h" #include ".h" /** * Dynamic factory for components of type: <code></code>. * A <i>dynamic factory</i> is a component that manages a pool of instances of * components of a certain type. Clients of the factory can require one of these * instances at run-time. After the factory hands over a component instance to its * client, the instance is marked as "in use" and cannot be given to any other * clients. When the requesting client has finished using the instance, it should release * it by marking it as "no longer in use". This will allow the factory to make it * available to other clients that request it. The "in use" status of the component * instances is controlled through method <code>setInUse</code> declared on * the component instances. * <p> * A dynamic factory is configured in two steps. The first step is performed * by the factory constructor when the internal data structures to hold the component * instances are created. The second step is performed during application initialization * when the component instances are loaded in the factory. Reconfiguration at run time * during normal application operation is not allowed. * <p> * Dynamic factories are implemented as singletons. They can exist in one single instance * that can be accessed through the <code>getInstance</code> method. * The one single instance of the class is created the first time that method * getInstance is called. In order to avoid possible disruptions of * real-time behaviour, applications should ensure that this method has been called * at least once before the application enters its operational phase. * <p> * This factory manages the following component instances:<ul> * <li>Number of instances of type <code></code>: </li> * </ul> * The code for this class was automatically generated by an XSL program processing * the XML-based application model. * @ingroup * @see * @author Automatically Generated Class * @version 1.0 */ class : public CC_RootObject { private: static * pInstance; unsigned int size; ** pool; protected: /** * Instantiate the factory component. The class identifier is set and * the internal data structures to hold the component instances managed * by the factory are created. * This constructor is defined to be protected because this is a singleton * class. */ (void); public: /** * Get the single instance of this singleton class. If the instance does not * yet exist, it is created. */ static * getInstance(void); /** * Check that all component instances required by the factory have been loaded. * @return true if the component is configured, false otherwise */ virtual bool isObjectConfigured(); /** * Load one instance of type <code></code> in the * factory. The component instances managed by the factory are internally stored in an * array. This method loads the i-th element of the array. The argument i should lie * in the interval [0,N-1] where N is the number of component instances of type * <code></code>. The value of N is defined by * the class constructor. * <p> * The "in use" status of a newly loaded component is initialized * to: "component is not in use". * <p> * This is an initialization method that should only be called during the application * configuration phase. * @param i the index in the internal array * @param pItem the component instance */ void set(unsigned int i, * pItem); /** * Return the number of component instances of type <code></code> * that are currently allocated. A component instance is allocated if its "in use" status is * equal to: "component is in use". * @return the number of allocated component instances */ unsigned int getNumber(void); /** * Return the number of component instances of type <code></code> * that are in the factory. The value returned is the maximum number of component instances of * type <code></code> that can be allocated. * @return the total number of component instances in the factory of * type <code></code> */ unsigned int getCapacity(void); /** * Allocate one instance of type <code></code>. * This method scans all the entries in the factory of type <code></code> * and returns the first one which is not in use. * In addition to verifyin that the returned component is not in use, this method also performs a check * on the value of the component configuration parameters. The folloging configuration parameters * are checked: , . * This method has a parameter matching each component configuration parameter. A component instance is * returned only if the value of the component configuration parameter is greater than or equal to the method * parameter. * Before being returned to the caller, * the status of the component instance is changed to: "in use". A client that receives * a component instance through a call to this method, should release the instance when it * no longer needs it. This can be done by calling * method <code>setInUse(false)</code> on the component itself. * <p> * If no free component instances are found, then the method returns null. Note that no * event report is generated to record the failure to allocate a component instance. Event * reporting is the responsibility of the caller. * @param minimum value for a component configuration parameter * @return the allocated component instance or null if no free instances were found */ * allocate(unsigned int , ); /** * Check whether a non-allocated component instance of type <code></code> * is available within the factory. If this method return true, then the corresponding * <code>allocate</code> method is guaranteed to return a non-null value. * The method parameters are used as in the corresponding <code>allocate</code> method. * @see #allocate * @param minimum value for a component configuration parameter * @return true if free instances of type are available, * false otherwise */ bool isFree(unsigned int , ); /** * Return the PUS data reporting packet that is currently allocated and whose SID is * equal to the value of the argument <code>sid</code>. * This method scans all the instances of type in the * factory and, if it finds one which is allocated (its status is "in use") and with the SID * equal to <code>sid</code>, it returns it. Otherwise, a null pointer is returned. * @param sid the structure identifier (SID) of the PUS data reporting packet * @return the sought PUS data reporting packet or null if no allocated data reporting packet * with SID equal to <code>sid</code> is found */ * get(TD_SID sid); }; #endif