FGPropertyValue Class Reference

Detailed Description

Represents a property value which can use late binding.

Author

Jon Berndt, Anders Gidenstam

Definition at line 62 of file FGPropertyValue.h.

#include <FGPropertyValue.h>

Inheritance diagram for FGPropertyValue:

Collaboration diagram for FGPropertyValue:

Public Member Functions
	FGPropertyValue (const std::string &propName, std::shared_ptr< FGPropertyManager > propertyManager, Element *el)
	FGPropertyValue (SGPropertyNode *propNode)
virtual std::string	GetFullyQualifiedName (void) const
std::string	GetName (void) const override
virtual std::string	GetNameWithSign (void) const
virtual std::string	GetPrintableName (void) const
double	GetValue (void) const override
bool	IsConstant (void) const override
bool	IsLateBound (void) const
void	SetNode (SGPropertyNode *node)
void	SetValue (double value)
Public Member Functions inherited from FGParameter
double	getDoubleValue (void) const

Protected Member Functions
SGPropertyNode *	GetNode (void) const

Constructor & Destructor Documentation

FGPropertyValue() [1/2]

FGPropertyValue ( SGPropertyNode *  propNode )

inlineexplicit

Definition at line 66 of file FGPropertyValue.h.

    : PropertyManager(nullptr), PropertyNode(propNode), Sign(1.0) {}

FGPropertyValue() [2/2]

FGPropertyValue	(	const std::string &	propName,
		std::shared_ptr< FGPropertyManager >	propertyManager,
		Element *	el
	)

Definition at line 44 of file FGPropertyValue.cpp.

  : PropertyManager(propertyManager), PropertyNode(nullptr), XML_def(el),
    PropertyName(propName), Sign(1.0)
{
  if (PropertyName[0] == '-') {
    PropertyName.erase(0,1);
    Sign = -1.0;
  }
 
  if (PropertyManager->HasNode(PropertyName)) {
    PropertyNode = PropertyManager->GetNode(PropertyName);
 
    assert(PropertyNode);
    XML_def = nullptr; // Now that the property is bound, we no longer need that.
  }
}

Member Function Documentation

GetFullyQualifiedName()

std::string GetFullyQualifiedName ( void  ) const

virtual

Definition at line 129 of file FGPropertyValue.cpp.

{
  if (PropertyNode)
    return JSBSim::GetFullyQualifiedName(PropertyNode);
  else
    return PropertyName;
}

GetName()

std::string GetName ( void  ) const

overridevirtual

Implements FGParameter.

Definition at line 106 of file FGPropertyValue.cpp.

{
  if (PropertyNode)
    return PropertyNode->getNameString();
  else
    return PropertyName;
}

GetNameWithSign()

std::string GetNameWithSign ( void  ) const

virtual

Definition at line 116 of file FGPropertyValue.cpp.

{
  string name;
 
  if (Sign < 0.0) name ="-";
 
  name += GetName();
 
  return name;
}

GetNode()

SGPropertyNode * GetNode ( void  ) const

protected

Definition at line 64 of file FGPropertyValue.cpp.

{
  if (PropertyNode) return PropertyNode;
 
  // Manage late binding.
  PropertyNode = PropertyManager->GetNode(PropertyName);
  if (!PropertyNode) {
    unique_ptr<LogException> err;
    if (XML_def)
      err.reset(new XMLLogException(XML_def));
    else
      err.reset(new LogException);
 
    *err << "FGPropertyValue::GetValue() The property " << PropertyName
         << " does not exist\n";
    throw *err;
  }
 
  XML_def = nullptr; // Now that the property is bound, we no longer need that.
 
  return PropertyNode;
}

GetPrintableName()

std::string GetPrintableName ( void  ) const

virtual

Definition at line 139 of file FGPropertyValue.cpp.

{
  if (PropertyNode)
    return JSBSim::GetPrintableName(PropertyNode);
  else
    return PropertyName;
}

GetValue()

double GetValue ( void  ) const

overridevirtual

Implements FGParameter.

Definition at line 89 of file FGPropertyValue.cpp.

{
  return GetNode()->getDoubleValue()*Sign;
}

IsConstant()

bool IsConstant ( void  ) const

inlineoverridevirtual

Reimplemented from FGParameter.

Definition at line 72 of file FGPropertyValue.h.

                                       {
    return PropertyNode && (!PropertyNode->isTied()
                         && !PropertyNode->getAttribute(SGPropertyNode::WRITE));
  }

IsLateBound()

bool IsLateBound ( void  ) const

inline

Definition at line 78 of file FGPropertyValue.h.

{ return PropertyNode == nullptr; }

SetNode()

void SetNode ( SGPropertyNode *  node )

inline

Definition at line 76 of file FGPropertyValue.h.

{PropertyNode = node;}

SetValue()

void SetValue

(

double

value

)

Definition at line 96 of file FGPropertyValue.cpp.

{
  // SetValue() ignores the Sign flag. So make sure it is never called with a
  // negative sign.
  assert(Sign == 1);
  GetNode()->setDoubleValue(value);
}

---

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

• FGPropertyValue.h
• FGPropertyValue.cpp