Dev Essential
Loading...
Searching...
No Matches
ddl::mapping::MemoryTarget Class Referenceabstract

Memory Target base class that represents a continuous memory buffer. More...

#include <mapper_interfaces.h>

Inherits ddl::mapping::Target.

Inherited by ddl::mapping::MapperElementBase< MemoryTarget >.

Public Member Functions

 ~MemoryTarget () override=default
 DTOR.
 
virtual size_t getExpectedDataSize () const =0
 Get the expected data size of the buffer.
 
virtual void updateMemory (std::shared_ptr< Memory > memory)=0
 Sets the target's memory buffer where to set the values to.
 
void reset () override
 resets the current memory buffer
 
- Public Member Functions inherited from ddl::mapping::Target
virtual std::vector< std::string > getAllValues () const =0
 Get all value names.
 
virtual std::shared_ptr< TargetValuegetValue (const std::string &value_name) const =0
 Get the value Target with a certain name.
 
- Public Member Functions inherited from ddl::mapping::MapperElement
virtual ~MapperElement ()=default
 DTOR.
 
virtual const std::string & getName () const =0
 Get the Name.
 
virtual const PropertiesgetProperties () const =0
 Get the Properties.
 
- Public Member Functions inherited from ddl::mapping::Updateable
virtual void updateBegin (std::chrono::nanoseconds)
 Function callback interface that is called before a value will be updated.
 
virtual void updateEnd ()
 Function callback interface that is called after a value was updated.
 

Detailed Description

Memory Target base class that represents a continuous memory buffer.

Member Function Documentation

◆ getExpectedDataSize()

virtual size_t ddl::mapping::MemoryTarget::getExpectedDataSize ( ) const
pure virtual

Get the expected data size of the buffer.

Returns
size_t

Implemented in ddl::mapping::DDLTarget.

◆ reset()

void ddl::mapping::MemoryTarget::reset ( )
inlineoverridevirtual

resets the current memory buffer

Reimplemented from ddl::mapping::Updateable.

◆ updateMemory()

virtual void ddl::mapping::MemoryTarget::updateMemory ( std::shared_ptr< Memory > memory)
pure virtual

Sets the target's memory buffer where to set the values to.

Parameters
memorythe memory buffer

Implemented in ddl::mapping::DDLTarget.


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