FGParameterValue Class Reference

Detailed Description

Represents a either a real value or a property value.

Author

Bertrand Coconnier

Definition at line 62 of file FGParameterValue.h.

#include <FGParameterValue.h>

Inheritance diagram for FGParameterValue:

Collaboration diagram for FGParameterValue:

Public Member Functions
	FGParameterValue (const std::string &value, std::shared_ptr< FGPropertyManager > pm, Element *el)
	FGParameterValue (Element *el, std::shared_ptr< FGPropertyManager > pm)
std::string	GetName (void) const override
double	GetValue (void) const override
bool	IsConstant (void) const override
bool	IsLateBound (void) const
Public Member Functions inherited from FGParameter
double	getDoubleValue (void) const

Constructor & Destructor Documentation

FGParameterValue() [1/2]

FGParameterValue ( Element *  el, std::shared_ptr< FGPropertyManager >  pm  )

inline

Definition at line 65 of file FGParameterValue.h.

  : FGParameterValue(el->GetDataLine(), pm, el)
  {
    std::string value = el->GetDataLine();
 
    if (el->GetNumDataLines() != 1 || value.empty()) {
      XMLLogException err(el);
      err << "The element <" << el->GetName()
          << "> must either contain a value number or a property name.\n";
      throw err;
    }
  }

FGParameterValue() [2/2]

FGParameterValue ( const std::string &  value, std::shared_ptr< FGPropertyManager >  pm, Element *  el  )

inline

Definition at line 78 of file FGParameterValue.h.

                                {
    try {
      param = new FGRealValue(atof_locale_c(value.c_str()));
    } catch (InvalidNumber&) {
      // "value" must be a property if execution passes to here.
      param = new FGPropertyValue(value, pm, el);
    }
  }

Member Function Documentation

GetName()

std::string GetName ( void  ) const

inlineoverridevirtual

Implements FGParameter.

Definition at line 91 of file FGParameterValue.h.

                                         {
    FGPropertyValue* v = dynamic_cast<FGPropertyValue*>(param.ptr());
    if (v)
      return v->GetNameWithSign();
    else
      return param->GetName();
  }

GetValue()

double GetValue ( void  ) const

inlineoverridevirtual

Implements FGParameter.

Definition at line 88 of file FGParameterValue.h.

{ return param->GetValue(); }

IsConstant()

bool IsConstant ( void  ) const

inlineoverridevirtual

Reimplemented from FGParameter.

Definition at line 89 of file FGParameterValue.h.

{ return param->IsConstant(); }

IsLateBound()

bool IsLateBound ( void  ) const

inline

Definition at line 99 of file FGParameterValue.h.

                               {
    FGPropertyValue* v = dynamic_cast<FGPropertyValue*>(param.ptr());
    return v != nullptr && v->IsLateBound();
  }

---

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

• FGParameterValue.h