NetDEM v1.0
Loading...
Searching...
No Matches
netdem::CollisionEntryParser Class Reference

A class that provides functions to convert collision entry data between a class and a struct format. More...

#include <collision_entry_parser.hpp>

Static Public Member Functions

static void ClassToStruct (const CollisionEntry *const entry_class, CollisionEntryData *const entry_struct)
 Converts collision entry data from a class to a struct format.
 
static void StructToClass (CollisionEntry *const entry_class, const CollisionEntryData *const entry_struct, const MiniMap< int, ContactModel * > &contact_model_map)
 Converts collision entry data from a struct to a class format.
 
static void DefineMPIDataType (MPI_Datatype *const datatype)
 Defines an MPI datatype for a CollisionEntryData struct.
 

Detailed Description

A class that provides functions to convert collision entry data between a class and a struct format.

The CollisionEntryParser class is used to provide functionality for converting collision entry data between a class and a struct format.

Member Function Documentation

◆ ClassToStruct()

void CollisionEntryParser::ClassToStruct ( const CollisionEntry *const entry_class,
CollisionEntryData *const entry_struct )
static

Converts collision entry data from a class to a struct format.

This function converts collision entry data from a CollisionEntry class format to a CollisionEntryData struct format.

Parameters
entry_classA pointer to the input CollisionEntry class instance.
entry_structA pointer to the output CollisionEntryData struct instance.

◆ DefineMPIDataType()

void CollisionEntryParser::DefineMPIDataType ( MPI_Datatype *const datatype)
static

Defines an MPI datatype for a CollisionEntryData struct.

This function defines an MPI datatype for a CollisionEntryData struct to be used in MPI communications.

Parameters
datatypeA pointer to the output datatype.

◆ StructToClass()

void CollisionEntryParser::StructToClass ( CollisionEntry *const entry_class,
const CollisionEntryData *const entry_struct,
const MiniMap< int, ContactModel * > & contact_model_map )
static

Converts collision entry data from a struct to a class format.

This function converts collision entry data from a CollisionEntryData struct format to a CollisionEntry class format.

Parameters
entry_classA pointer to the output CollisionEntry class instance.
entry_structA pointer to the input CollisionEntryData struct instance.
contact_model_mapA map of ID-contact model pairs used for setting the correct contact model in the output CollisionEntry class instance.

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