OpenWalnut  1.5.0dev
Public Types | Public Member Functions | Private Attributes | List of all members
WOutputPropertyHandler Class Reference

Creates, updates and handles the output properties. More...

#include <WOutputPropertyHandler.h>

+ Collaboration diagram for WOutputPropertyHandler:

Public Types

typedef std::shared_ptr< WOutputPropertyHandlerSPtr
 shared_ptr that points to itself. More...
 
typedef boost::function< void() > CallbackPtr
 Function typedf for updating the data. More...
 

Public Member Functions

 WOutputPropertyHandler (WProtonData::SPtr protonData, WPropertyGroup::SPtr properties, WOutputPropertyHandler::CallbackPtr dataUpdate)
 constructor More...
 
void createProperties ()
 creates the group property and the subroperties. More...
 
void updateProperties ()
 update current group property and the subproperties. More...
 
WPropBool getEnergyDeposition ()
 Getter. More...
 
WPropBool getEventID ()
 Getter. More...
 

Private Attributes

WProtonData::SPtr m_protonData
 Pointer to the content and header of the CSV. More...
 
WPropertyGroup::SPtr m_properties
 A property variable that is generated by the WModul. More...
 
WOutputPropertyHandler::CallbackPtr m_dataUpdate
 A function variable that reinitializes the WDataSets. More...
 
WPropBool m_energyDeposition
 Whether to send the energy deposition or not. More...
 
WPropBool m_eventID
 Whether to send the eventID or not. More...
 

Detailed Description

Creates, updates and handles the output properties.

Definition at line 33 of file WOutputPropertyHandler.h.

Member Typedef Documentation

◆ CallbackPtr

typedef boost::function< void() > WOutputPropertyHandler::CallbackPtr

Function typedf for updating the data.

Definition at line 44 of file WOutputPropertyHandler.h.

◆ SPtr

shared_ptr that points to itself.

Definition at line 39 of file WOutputPropertyHandler.h.

Constructor & Destructor Documentation

◆ WOutputPropertyHandler()

WOutputPropertyHandler::WOutputPropertyHandler ( WProtonData::SPtr  protonData,
WPropertyGroup::SPtr  properties,
WOutputPropertyHandler::CallbackPtr  dataUpdate 
)
explicit

constructor

Parameters
protonDataPointer to the content and header of the CSV.
propertiesA property variable that is generated by the WModul.
dataUpdateA function variable that reinitializes the WDataSets.

Definition at line 27 of file WOutputPropertyHandler.cpp.

Member Function Documentation

◆ createProperties()

void WOutputPropertyHandler::createProperties ( )

creates the group property and the subroperties.

Definition at line 36 of file WOutputPropertyHandler.cpp.

References m_energyDeposition, m_eventID, m_properties, and updateProperties().

+ Here is the call graph for this function:

◆ getEnergyDeposition()

WPropBool WOutputPropertyHandler::getEnergyDeposition ( )

Getter.

Returns
WPropBool of the energy deposition.

Definition at line 49 of file WOutputPropertyHandler.cpp.

References m_energyDeposition.

◆ getEventID()

WPropBool WOutputPropertyHandler::getEventID ( )

Getter.

Returns
WPropBool of the eventID.

Definition at line 54 of file WOutputPropertyHandler.cpp.

References m_eventID.

◆ updateProperties()

void WOutputPropertyHandler::updateProperties ( )

update current group property and the subproperties.

Definition at line 44 of file WOutputPropertyHandler.cpp.

References m_dataUpdate.

Referenced by createProperties().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_dataUpdate

WOutputPropertyHandler::CallbackPtr WOutputPropertyHandler::m_dataUpdate
private

A function variable that reinitializes the WDataSets.

Definition at line 80 of file WOutputPropertyHandler.h.

Referenced by updateProperties().

◆ m_energyDeposition

WPropBool WOutputPropertyHandler::m_energyDeposition
private

Whether to send the energy deposition or not.

Definition at line 82 of file WOutputPropertyHandler.h.

Referenced by createProperties(), and getEnergyDeposition().

◆ m_eventID

WPropBool WOutputPropertyHandler::m_eventID
private

Whether to send the eventID or not.

Definition at line 83 of file WOutputPropertyHandler.h.

Referenced by createProperties(), and getEventID().

◆ m_properties

WPropertyGroup::SPtr WOutputPropertyHandler::m_properties
private

A property variable that is generated by the WModul.

Definition at line 79 of file WOutputPropertyHandler.h.

Referenced by createProperties().

◆ m_protonData

WProtonData::SPtr WOutputPropertyHandler::m_protonData
private

Pointer to the content and header of the CSV.

Definition at line 78 of file WOutputPropertyHandler.h.


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