World Ocean Simulation System (WOSS) library
woss::CustomTransducer Struct Reference

Initial set up of a transducer. More...

#include <woss-creator-container.h>

Collaboration diagram for woss::CustomTransducer:
Collaboration graph

Public Member Functions

 CustomTransducer (const ::std::string &name="", double bearing=0.0, double vert_rot=0.0, double horiz_rot=0.0, double mult=1.0, double add=0.0)
 

Public Attributes

::std::string type
 
double initial_bearing
 
double initial_vert_rotation
 
double initial_horiz_rotation
 
double multiply_costant
 
double add_costant
 

Friends

std::ostream & operator<< (std::ostream &os, const CustomTransducer &instance)
 

Detailed Description

Initial set up of a transducer.

Struct that stores the Transducer's type name, its vertical beam pattern initial rotation, multiplicative and additive constants.

Constructor & Destructor Documentation

◆ CustomTransducer()

woss::CustomTransducer::CustomTransducer ( const ::std::string &  name = "",
double  bearing = 0.0,
double  vert_rot = 0.0,
double  horiz_rot = 0.0,
double  mult = 1.0,
double  add = 0.0 
)
inline

Default constructor

Parameters
nametransducer's type name
rotinitial rotation [decimal degrees]
multmultiplicative constant
addadditive constant

Member Data Documentation

◆ add_costant

double woss::CustomTransducer::add_costant

beam pattern additive constant

Referenced by woss::BellhopCreator::initializeBhWoss().

◆ initial_bearing

double woss::CustomTransducer::initial_bearing

beam pattern bearing orientation

Referenced by woss::BellhopCreator::initializeBhWoss().

◆ initial_horiz_rotation

double woss::CustomTransducer::initial_horiz_rotation

beam pattern initial horizontal rotation [decimal degrees]

Referenced by woss::BellhopCreator::initializeBhWoss().

◆ initial_vert_rotation

double woss::CustomTransducer::initial_vert_rotation

beam pattern initial vertical rotation [decimal degrees]

Referenced by woss::BellhopCreator::initializeBhWoss().

◆ multiply_costant

double woss::CustomTransducer::multiply_costant

beam pattern multiplicative constant

Referenced by woss::BellhopCreator::initializeBhWoss().

◆ type

::std::string woss::CustomTransducer::type

transducer type name

Referenced by woss::BellhopCreator::initializeBhWoss().


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