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

References add_costant, initial_bearing, initial_horiz_rotation, initial_vert_rotation, multiply_costant, and type.

Referenced by operator<<.

◆ operator<<

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

Member Data Documentation

◆ add_costant

double woss::CustomTransducer::add_costant

◆ initial_bearing

double woss::CustomTransducer::initial_bearing

◆ initial_horiz_rotation

double woss::CustomTransducer::initial_horiz_rotation

beam pattern initial horizontal rotation [decimal degrees]

Referenced by CustomTransducer(), woss::BellhopCreator::initializeBhWoss(), operator<<, and WossUnitTest::testWossCreatorContainer().

◆ initial_vert_rotation

double woss::CustomTransducer::initial_vert_rotation

beam pattern initial vertical rotation [decimal degrees]

Referenced by CustomTransducer(), woss::BellhopCreator::initializeBhWoss(), operator<<, and WossUnitTest::testWossCreatorContainer().

◆ multiply_costant

double woss::CustomTransducer::multiply_costant

◆ type

std::string woss::CustomTransducer::type

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