ocra-recipes
Doxygen documentation for the ocra-recipes repository
Public Member Functions | List of all members
ocra::VariableMapping Class Reference

A class to manage the relative mapping of a variable with respect to another one. More...

#include <VariableMapping.h>

Public Member Functions

 VariableMapping (const Variable &relative, const Variable &base)
 
 ~VariableMapping ()
 
const std::vector< int > & getMapping () const
 
const VariablegetBaseVariable () const
 
const VariablegetRelativeVariable () const
 

Detailed Description

A class to manage the relative mapping of a variable with respect to another one.

The role of VariableMapping is to provide the relative mapping of one variable v1 wrt. another v2 as it could be directly obtained by invoking v2.getRelativeMappingOf(v1, returnVector). The mapping is updated whenever it is needed (i.e. after an event EVT_RESIZE or EVT_CHANGE_DEPENDENCIES was triggered by one of the two variable).

Definition at line 34 of file VariableMapping.h.

Constructor & Destructor Documentation

ocra::VariableMapping::VariableMapping ( const Variable relative,
const Variable base 
)

Definition at line 10 of file VariableMapping.cpp.

ocra::VariableMapping::~VariableMapping ( )

Definition at line 19 of file VariableMapping.cpp.

Member Function Documentation

const Variable & ocra::VariableMapping::getBaseVariable ( ) const

Definition at line 34 of file VariableMapping.cpp.

const std::vector< int > & ocra::VariableMapping::getMapping ( ) const

Definition at line 27 of file VariableMapping.cpp.

const Variable & ocra::VariableMapping::getRelativeVariable ( ) const

Definition at line 39 of file VariableMapping.cpp.


The documentation for this class was generated from the following files: