FGElectricalComponent Class Reference

#include <electrical.hxx>

Inherited by FGElectricalBus, FGElectricalConnector, FGElectricalOutput, and FGElectricalSupplier.

Public Types
enum	FGElectricalComponentType {   FG_UNKNOWN , FG_SUPPLIER , FG_BUS , FG_OUTPUT ,   FG_CONNECTOR }

Public Member Functions
	FGElectricalComponent ()
virtual	~FGElectricalComponent ()=default
const std::string &	get_name ()
int	get_kind () const
float	get_volts () const
void	set_volts (float val)
float	get_load_amps () const
void	set_load_amps (float val)
float	get_available_amps () const
void	set_available_amps (float val)
int	get_num_inputs () const
FGElectricalComponent *	get_input (const int i)
void	add_input (FGElectricalComponent *c)
int	get_num_outputs () const
FGElectricalComponent *	get_output (const int i)
void	add_output (FGElectricalComponent *c)
void	add_prop (const std::string &s)
void	publishVoltageToProps () const

Protected Types
using	comp_list = std::vector<FGElectricalComponent*>

Protected Attributes
int	kind
std::string	name
float	volts
float	load_amps
float	available_amps
comp_list	inputs
comp_list	outputs
simgear::PropertyList	props

Detailed Description

Definition at line 22 of file electrical.hxx.

Member Typedef Documentation

comp_list

using FGElectricalComponent::comp_list = std::vector<FGElectricalComponent*>

protected

Definition at line 34 of file electrical.hxx.

Member Enumeration Documentation

FGElectricalComponentType

enum FGElectricalComponent::FGElectricalComponentType

Enumerator
FG_UNKNOWN
FG_SUPPLIER
FG_BUS
FG_OUTPUT
FG_CONNECTOR

Definition at line 25 of file electrical.hxx.

Constructor & Destructor Documentation

FGElectricalComponent()

FGElectricalComponent::FGElectricalComponent

(

)

Definition at line 27 of file electrical.cxx.

~FGElectricalComponent()

virtual FGElectricalComponent::~FGElectricalComponent ( )

virtualdefault

Member Function Documentation

add_input()

void FGElectricalComponent::add_input ( FGElectricalComponent * c )

inline

Definition at line 71 of file electrical.hxx.

add_output()

void FGElectricalComponent::add_output ( FGElectricalComponent * c )

inline

Definition at line 81 of file electrical.hxx.

add_prop()

void FGElectricalComponent::add_prop

(

const std::string &

s

)

Definition at line 35 of file electrical.cxx.

get_available_amps()

float FGElectricalComponent::get_available_amps ( ) const

inline

Definition at line 63 of file electrical.hxx.

get_input()

FGElectricalComponent * FGElectricalComponent::get_input ( const int i )

inline

Definition at line 67 of file electrical.hxx.

get_kind()

int FGElectricalComponent::get_kind ( ) const

inline

Definition at line 55 of file electrical.hxx.

get_load_amps()

float FGElectricalComponent::get_load_amps ( ) const

inline

Definition at line 60 of file electrical.hxx.

get_name()

const std::string & FGElectricalComponent::get_name ( )

inline

Definition at line 53 of file electrical.hxx.

get_num_inputs()

int FGElectricalComponent::get_num_inputs ( ) const

inline

Definition at line 66 of file electrical.hxx.

get_num_outputs()

int FGElectricalComponent::get_num_outputs ( ) const

inline

Definition at line 76 of file electrical.hxx.

get_output()

FGElectricalComponent * FGElectricalComponent::get_output ( const int i )

inline

Definition at line 77 of file electrical.hxx.

get_volts()

float FGElectricalComponent::get_volts ( ) const

inline

Definition at line 57 of file electrical.hxx.

publishVoltageToProps()

void FGElectricalComponent::publishVoltageToProps

(

)

const

Definition at line 41 of file electrical.cxx.

set_available_amps()

void FGElectricalComponent::set_available_amps ( float val )

inline

Definition at line 64 of file electrical.hxx.

set_load_amps()

void FGElectricalComponent::set_load_amps ( float val )

inline

Definition at line 61 of file electrical.hxx.

set_volts()

void FGElectricalComponent::set_volts ( float val )

inline

Definition at line 58 of file electrical.hxx.

Member Data Documentation

available_amps

float FGElectricalComponent::available_amps

protected

Definition at line 41 of file electrical.hxx.

inputs

comp_list FGElectricalComponent::inputs

protected

Definition at line 44 of file electrical.hxx.

kind

int FGElectricalComponent::kind

protected

Definition at line 36 of file electrical.hxx.

load_amps

float FGElectricalComponent::load_amps

protected

Definition at line 39 of file electrical.hxx.

name

std::string FGElectricalComponent::name

protected

Definition at line 37 of file electrical.hxx.

outputs

comp_list FGElectricalComponent::outputs

protected

Definition at line 45 of file electrical.hxx.

props

simgear::PropertyList FGElectricalComponent::props

protected

Definition at line 47 of file electrical.hxx.

volts

float FGElectricalComponent::volts

protected

Definition at line 38 of file electrical.hxx.

---

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

• electrical.hxx
• electrical.cxx