libalmemoryfastaccess  1.14
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Groups Pages
Public Member Functions | Static Public Member Functions
AL::ALMemoryFastAccess Class Reference

ALMemoryFastAccess is a fast access in Read/Write to some variables of ALMemory. More...

#include <almemoryfastaccess/almemoryfastaccess.h>

List of all members.

Public Member Functions

 ALMemoryFastAccess ()
 Default constructor.
 ~ALMemoryFastAccess ()
 Default destructor.
void insertBuffer (const std::string &pName, const ALValue &pBuff)
 Insert a binary ALValue in ALMemory.
template<typename C >
void insertObject (const std::string &pName, C pObject)
 Insert serializable C++ object.
void ConnectToVariables (const boost::shared_ptr< AL::ALBroker > pBroker, const std::vector< std::string > &pListVariables, bool bAllowNonExistantVariable=false)
 First time, you must "connect" to variables to access later, many times.
void directConnectToVariables (const boost::shared_ptr< AL::ALBroker > pBroker, const std::vector< std::string > &pListVariables, bool bAllowUnexistantVariable=false)
 FIXME: No implementation.
void GetValues (std::vector< float > &pListValue) const
 Get previous "connected" variables.
void SetValues (const std::vector< float > &pListValue)
 Set previous "connected" variables.

Static Public Member Functions

static void StopAllAccess (void)
 Remove all pointer.
template<typename C >
static C getObject (const std::string &pName)
 Get C++ object.
static void * getDataPtr (boost::shared_ptr< AL::ALBroker > pBroker, const std::string &pStrValue, bool bAllowUnexistantVariable)
 Get pointer on 32bit data.
static bool InnerTest (const boost::shared_ptr< AL::ALBroker > pBroker)
 Test function.

Detailed Description

ALMemoryFastAccess is a fast access in Read/Write to some variables of ALMemory.

ALMemoryFastAccess is a fast access in Read/Write to some variables of ALMemory regularily accessed, with a unified interface.

Definition at line 40 of file almemoryfastaccess.h.


Member Function Documentation

void AL::ALMemoryFastAccess::ConnectToVariables ( const boost::shared_ptr< AL::ALBroker pBroker,
const std::vector< std::string > &  pListVariables,
bool  bAllowNonExistantVariable = false 
)

First time, you must "connect" to variables to access later, many times.

Parameters:
pBrokera pointer to the broker
pListVariableslist of variable names, eg: {"DCM/Sensor1", "DCM/Sensor2"} ...
bAllowNonExistantVariableunused parameter
void AL::ALMemoryFastAccess::directConnectToVariables ( const boost::shared_ptr< AL::ALBroker pBroker,
const std::vector< std::string > &  pListVariables,
bool  bAllowUnexistantVariable = false 
)

FIXME: No implementation.

Parameters:
pBrokera pointer to the broker
pListVariableslist of variable names, eg: {"DCM/Sensor1", "DCM/Sensor2"} ...
bAllowUnexistantVariableunused parameter
static void* AL::ALMemoryFastAccess::getDataPtr ( boost::shared_ptr< AL::ALBroker pBroker,
const std::string &  pStrValue,
bool  bAllowUnexistantVariable 
)
static

Get pointer on 32bit data.

Parameters:
pBrokera pointer to the broker
pStrValuevalue name
bAllowUnexistantVariableunused parameter
template<typename C >
static C AL::ALMemoryFastAccess::getObject ( const std::string &  pName)
inlinestatic

Get C++ object.

Parameters:
pNamevalue's name
Returns:
C++ object

Definition at line 109 of file almemoryfastaccess.h.

void AL::ALMemoryFastAccess::GetValues ( std::vector< float > &  pListValue) const

Get previous "connected" variables.

Parameters:
pListValuewhere to put the gathered value of variables
static bool AL::ALMemoryFastAccess::InnerTest ( const boost::shared_ptr< AL::ALBroker pBroker)
static

Test function.

Parameters:
pBrokera pointer to the broker
Returns:
true if test ok, false otherwise
void AL::ALMemoryFastAccess::insertBuffer ( const std::string &  pName,
const ALValue &  pBuff 
)

Insert a binary ALValue in ALMemory.

Parameters:
pNamevalue
pBuffALValue
template<typename C >
void AL::ALMemoryFastAccess::insertObject ( const std::string &  pName,
pObject 
)
inline

Insert serializable C++ object.

Parameters:
pNamevalue's name
pObjectC++ object

Definition at line 94 of file almemoryfastaccess.h.

void AL::ALMemoryFastAccess::SetValues ( const std::vector< float > &  pListValue)

Set previous "connected" variables.

Parameters:
pListValueValue of variables to put into memory.

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