PortSettings Class Reference

#include "PortSettings.h"

Public Member Functions
PortSettings &	operator= (PortSettings &other)=delete
	PortSettings (std::string portName, std::string excitationTarget, std::string excitationAxis, std::string excitationSignal)
void	SetExcitationPoint (index_t x, index_t y, index_t z)
const index_t	GetCoorX () const
const index_t	GetCoorY () const
const index_t	GetCoorZ () const
const bool	LocationIsInCentre () const
const std::string	GetPortName () const
const sourceType	GetSourceType () const
const axis	GetAxis () const
const std::string	GetExcitationSignalName (void)
void	SetExcitationSignal (Signal excitationSignal)
const Signal	GetExcitationSignal (void)
std::string	Print ()

Constructor & Destructor Documentation

PortSettings()

PortSettings::PortSettings	(	std::string	portName,
		std::string	excitationTarget,
		std::string	excitationAxis,
		std::string	excitationSignal )

Parameters

portName
excitationTarget
excitationAxis
excitationSignal

Exceptions

invalid_argument

if excitation axis or target are not included in map.

Member Function Documentation

GetAxis()

const axis PortSettings::GetAxis ( ) const

inline

GetCoorX()

const index_t PortSettings::GetCoorX ( ) const

inline

GetCoorY()

const index_t PortSettings::GetCoorY ( ) const

inline

GetCoorZ()

const index_t PortSettings::GetCoorZ ( ) const

inline

GetExcitationSignal()

const Signal PortSettings::GetExcitationSignal ( void )

inline

GetExcitationSignalName()

const std::string PortSettings::GetExcitationSignalName ( void )

inline

GetPortName()

const std::string PortSettings::GetPortName ( ) const

inline

GetSourceType()

const sourceType PortSettings::GetSourceType ( ) const

inline

LocationIsInCentre()

const bool PortSettings::LocationIsInCentre ( ) const

inline

operator=()

PortSettings & PortSettings::operator= ( PortSettings & other )

delete

Print()

std::string PortSettings::Print

(

)

SetExcitationPoint()

void PortSettings::SetExcitationPoint	(	index_t	x,
		index_t	y,
		index_t	z )

SetExcitationSignal()

void PortSettings::SetExcitationSignal ( Signal excitationSignal )

inline

---

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

• Services/FITTDService/include/SolverSettings/PortSettings.h
• Services/FITTDService/src/SolverSettings/PortSettings.cpp