Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

DataPoolControlBlock Class Reference
[Data Processing]

#include <DataPoolControlBlock.h>

Inheritance diagram for DataPoolControlBlock:

ControlBlock CC_RootObject DC_DummyDataPoolControlBlock DC_MatlabDataPoolPID DC_SampleControlBlock_1 DC_SampleControlBlock_2 DC_SampleControlBlock_3 DC_SampleControlBlock_4 List of all members.

Detailed Description

Base class for data pool control blocks.

A data pool control block is a control block that takes its inputs from locations in the data pool and writes its outputs into locations in the data pool. The data pool locations for the inputs and the outputs are defined as configuration parameters for the control block. This class therefore adds the following attributes to its ControlBlock base class:<ul> The input identifiers: the identifiers of the data pool items in the data pool from which the input values are read. The output identifiers: the identifiers of the data pool items in the data pool to which the output values are written. This class adds services to set up the link between the block inputs and outputs and the data pool locations from which the inputs are read and to which the outputs are written.

See also:
DataPool
Author:
Alessandro Pasetti, Roberto Totaro
Version:
1.0

Definition at line 36 of file DataPoolControlBlock.h.

Public Member Functions

 DataPoolControlBlock ()
 Instantiate a data pool control block.

void setInputLink (unsigned int i, TD_DataPoolId dpIdentifier)
 Set the data pool identifier for the i-th input.

void setOutputLink (unsigned int i, TD_DataPoolId dpIdentifier)
 Set the data pool identifier for the i-th output.

virtual bool isObjectConfigured (void)
 Perform a class-specific configuration check on a pointer control block.


Protected Member Functions

virtual void setNumberOfInputs (unsigned int n)
 Set the number of inputs.

virtual void setNumberOfOutputs (unsigned int n)
 Set the number of outputs.


Protected Attributes

TD_DataPoolId * dpu
 Array of input identifiers.

TD_DataPoolId * dpy
 Array of output identifiers.

Constructor & Destructor Documentation

DataPoolControlBlock::DataPoolControlBlock (   ) 
 

Instantiate a data pool control block.

The input identifiers and output identifiers are initialized to illegal values to signify that the component is not yet configured. The data pool is loaded from class CC_RootObject.

Definition at line 18 of file DataPoolControlBlock.cpp.

Member Function Documentation

bool DataPoolControlBlock::isObjectConfigured (  void   )  [virtual]
 

Perform a class-specific configuration check on a pointer control block.

It is checked that the input and output identifiers have been defined.

Reimplemented from ControlBlock.

Definition at line 59 of file DataPoolControlBlock.cpp.

void DataPoolControlBlock::setInputLink (  unsigned int  i,
TD_DataPoolId  dpIdentifier
) 
 

Set the data pool identifier for the i-th input.

The argument i must lie in the interval [0,n-1] where n is the number of inputs. An illegal value for argument i triggers the generation of an event report EVT_ILLEGAL_CB. There is no check on the legality of the data pool identifier. This should normally be a valid identifier for an item of type TD_Float.

Parameters:
i the index of the input
dpIdentifier the data pool item identifier

Definition at line 41 of file DataPoolControlBlock.cpp.

void DataPoolControlBlock::setNumberOfInputs (  unsigned int  n  )  [protected, virtual]
 

Set the number of inputs.

This method causes the memory for the array holding the input identifiers to be allocated.

Parameters:
n the number of inputs

Implements ControlBlock.

Definition at line 23 of file DataPoolControlBlock.cpp.

void DataPoolControlBlock::setNumberOfOutputs (  unsigned int  n  )  [protected, virtual]
 

Set the number of outputs.

This method causes the memory for the array holding the output identifiers to be allocated.

Parameters:
n the number of outputs

Implements ControlBlock.

Definition at line 32 of file DataPoolControlBlock.cpp.

void DataPoolControlBlock::setOutputLink (  unsigned int  i,
TD_DataPoolId  dpIdentifier
) 
 

Set the data pool identifier for the i-th output.

The argument i must lie in the interval [0,n-1] where n is the number of outputs. An illegal value for argument i triggers the generation of an event report EVT_ILLEGAL_CB. There is no check on the legality of the data pool identifier. This should normally be a valid identifier for an item of type TD_Float.

Parameters:
i the index of the input
dpIdentifier the data pool item identifier

Definition at line 50 of file DataPoolControlBlock.cpp.

Member Data Documentation

TD_DataPoolId* DataPoolControlBlock::dpu [protected]
 

Array of input identifiers.

Element dpu[i] holds the identifier of the data pool item that provides the i-th input variable. The integer i must lie in the interval [0,N-1] where N is the number of inputs.

See also:
setInputLink

Definition at line 45 of file DataPoolControlBlock.h.

TD_DataPoolId* DataPoolControlBlock::dpy [protected]
 

Array of output identifiers.

Element dpy[i] holds the identifier of the data pool item that receives the i-th output variable. The integer i must lie in the interval [0,N-1] where N is the number of outputs.

See also:
setOutputLink

Definition at line 54 of file DataPoolControlBlock.h.

The documentation for this class was generated from the following files:
Copyright 2003 P&P Software GmbH - All Rights Reserved