FGPropertyManager Class Reference

Detailed Description

Class wrapper for property handling.

Author

David Megginson, Tony Peden

Definition at line 76 of file FGPropertyManager.h.

#include <FGPropertyManager.h>

Public Member Functions
	FGPropertyManager (SGPropertyNode *_root)
	Constructor.
	FGPropertyManager (void)
	Default constructor.
virtual	~FGPropertyManager (void)
	Destructor.
SGPropertyNode *	GetNode (const std::string &path, bool create=false)
SGPropertyNode *	GetNode (const std::string &relpath, int index, bool create=false)
SGPropertyNode *	GetNode (void) const
bool	HasNode (const std::string &path) const
std::string	mkPropertyName (std::string name, bool lowercase)
	Property-ify a name replaces spaces with '-' and, optionally, makes name all lower case.
template<typename T >
void	Tie (const std::string &name, int index, T(*getter)(int), void(*setter)(int, T)=nullptr)
	Tie a property to a pair of indexed functions.
template<class T , class V >
void	Tie (const std::string &name, T *obj, int index, V(T::*getter)(int) const, void(T::*setter)(int, V)=nullptr)
	Tie a property to a pair of indexed object methods.
template<class T , class V >
void	Tie (const std::string &name, T *obj, V(T::*getter)() const, void(T::*setter)(V)=nullptr)
	Tie a property to a pair of object methods.
template<typename T >
void	Tie (const std::string &name, T *pointer)
	Tie a property to an external variable.
template<typename T >
void	Tie (const std::string &name, T(*getter)(), void(*setter)(T)=nullptr)
	Tie a property to a pair of simple functions.
template<typename T >
void	Unbind (const std::shared_ptr< T > &instance)
	Unbind all properties bound by this manager to an instance.
void	Unbind (const void *instance)
	Unbind all properties bound by this manager to an instance.
void	Unbind (void)
	Unbind all properties bound by this manager to an external data source.
void	Untie (const std::string &name)
	Untie a property from an external data source.
void	Untie (SGPropertyNode *property)
	Untie a property from an external data source.

Constructor & Destructor Documentation

FGPropertyManager() [1/2]

FGPropertyManager ( void  )

inline

Default constructor.

Definition at line 80 of file FGPropertyManager.h.

{ root = new SGPropertyNode; }

FGPropertyManager() [2/2]

FGPropertyManager ( SGPropertyNode *  _root )

inlineexplicit

Constructor.

Definition at line 83 of file FGPropertyManager.h.

: root(_root) {};

~FGPropertyManager()

virtual ~FGPropertyManager ( void  )

inlinevirtual

Destructor.

Definition at line 86 of file FGPropertyManager.h.

{ Unbind(); }

Member Function Documentation

GetNode() [1/3]

SGPropertyNode * GetNode ( const std::string &  path, bool  create = false  )

inline

Definition at line 89 of file FGPropertyManager.h.

    { return root->getNode(path, create); }

GetNode() [2/3]

SGPropertyNode * GetNode ( const std::string &  relpath, int  index, bool  create = false  )

inline

Definition at line 91 of file FGPropertyManager.h.

    { return root->getNode(relpath, index, create); }

GetNode() [3/3]

SGPropertyNode * GetNode ( void  ) const

inline

Definition at line 88 of file FGPropertyManager.h.

{ return root; }

HasNode()

bool HasNode ( const std::string &  path ) const

inline

Definition at line 93 of file FGPropertyManager.h.

    {
      std::string newPath = path;
      if (newPath[0] == '-') newPath.erase(0,1);
      SGPropertyNode* prop = root->getNode(newPath);
      return prop != nullptr;
    }

mkPropertyName()

string mkPropertyName	(	std::string	name,
		bool	lowercase
	)

Property-ify a name replaces spaces with '-' and, optionally, makes name all lower case.

Parameters

name	string to change
lowercase	true to change all upper case chars to lower NOTE: this function changes its argument and thus relies on pass by value

Definition at line 79 of file FGPropertyManager.cpp.

                                                                    {
 
  /* do this two pass to avoid problems with characters getting skipped
     because the index changed */
  unsigned i;
  for(i=0;i<name.length();i++) {
    if( lowercase && isupper(name[i]) )
      name[i]=tolower(name[i]);
    else if( isspace(name[i]) )
      name[i]='-';
  }
 
  return name;
}

Tie() [1/5]

template<typename T >

void Tie ( const std::string &  name, int  index, T(*)(int)  getter, void(*)(int, T)  setter = nullptr  )

inline

Tie a property to a pair of indexed functions.

Every time the property value is queried, the getter (if any) will be invoked with the index provided; every time the property value is modified, the setter (if any) will be invoked with the index provided. The getter can be 0 to make the property unreadable, and the setter can be 0 to make the property unmodifiable.

Parameters

name	The property name to tie (full path).
index	The integer argument to pass to the getter and setter functions.
getter	The getter function, or 0 if the value is unreadable.
setter	The setter function, or 0 if the value is unmodifiable.

Definition at line 235 of file FGPropertyManager.h.

    {
      SGPropertyNode* property = root->getNode(name.c_str(), true);
      if (!property) {
        std::cerr << "Could not get or create property " << name << std::endl;
        return;
      }
 
      if (!property->tie(SGRawValueFunctionsIndexed<T>(index, getter, setter),
                                                       false))
        std::cerr << "Failed to tie property " << name << " to indexed functions"
                  << std::endl;
      else {
        tied_properties.push_back(PropertyState(property, nullptr));
        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Here is the call graph for this function:

Tie() [2/5]

template<class T , class V >

void Tie ( const std::string &  name, T *  obj, int  index, V(T::*)(int) const  getter, void(T::*)(int, V)  setter = nullptr  )

inline

Tie a property to a pair of indexed object methods.

Every time the property value is queried, the getter (if any) will be invoked with the index provided; every time the property value is modified, the setter (if any) will be invoked with the index provided. The getter can be 0 to make the property unreadable, and the setter can be 0 to make the property unmodifiable.

Parameters

name	The property name to tie (full path).
obj	The object whose methods should be invoked.
index	The integer argument to pass to the getter and setter methods.
getter	The getter method, or 0 if the value is unreadable.
setter	The setter method, or 0 if the value is unmodifiable.

Definition at line 310 of file FGPropertyManager.h.

    {
      SGPropertyNode* property = root->getNode(name.c_str(), true);
      if (!property) {
        std::cerr << "Could not get or create property " << name << std::endl;
        return;
      }
 
      if (!property->tie(SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter),
                                                       false))
        std::cerr << "Failed to tie property " << name
                  << " to indexed object methods" << std::endl;
      else {
        tied_properties.push_back(PropertyState(property, obj));
        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
   }

Here is the call graph for this function:

Tie() [3/5]

template<class T , class V >

void Tie ( const std::string &  name, T *  obj, V(T::*)() const  getter, void(T::*)(V)  setter = nullptr  )

inline

Tie a property to a pair of object methods.

Every time the property value is queried, the getter (if any) will be invoked; every time the property value is modified, the setter (if any) will be invoked. The getter can be 0 to make the property unreadable, and the setter can be 0 to make the property unmodifiable.

Parameters

name	The property name to tie (full path).
obj	The object whose methods should be invoked.
getter	The object's getter method, or 0 if the value is unreadable.
setter	The object's setter method, or 0 if the value is unmodifiable.

Definition at line 273 of file FGPropertyManager.h.

    {
      SGPropertyNode* property = root->getNode(name.c_str(), true);
      if (!property) {
        std::cerr << "Could not get or create property " << name << std::endl;
        return;
      }
 
      if (!property->tie(SGRawValueMethods<T,V>(*obj, getter, setter), false))
        std::cerr << "Failed to tie property " << name << " to object methods"
                  << std::endl;
      else {
        tied_properties.push_back(PropertyState(property, obj));
        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Here is the call graph for this function:

Tie() [4/5]

template<typename T >

void Tie ( const std::string &  name, T *  pointer  )

inline

Tie a property to an external variable.

The property's value will automatically mirror the variable's value, and vice-versa, until the property is untied.

Parameters

name	The property name to tie (full path).
pointer	A pointer to the variable.

Definition at line 169 of file FGPropertyManager.h.

    {
      SGPropertyNode* property = root->getNode(name.c_str(), true);
      if (!property) {
        std::cerr << "Could not get or create property " << name << std::endl;
        return;
      }
 
      if (!property->tie(SGRawValuePointer<T>(pointer), false))
          std::cerr << "Failed to tie property " << name << " to a pointer" << std::endl;
      else {
        tied_properties.push_back(PropertyState(property, nullptr));
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Here is the call graph for this function:

Tie() [5/5]

template<typename T >

void Tie ( const std::string &  name, T(*)()  getter, void(*)(T)  setter = nullptr  )

inline

Tie a property to a pair of simple functions.

Every time the property value is queried, the getter (if any) will be invoked; every time the property value is modified, the setter (if any) will be invoked. The getter can be 0 to make the property unreadable, and the setter can be 0 to make the property unmodifiable.

Parameters

name	The property name to tie (full path).
getter	The getter function, or 0 if the value is unreadable.
setter	The setter function, or 0 if the value is unmodifiable.

Definition at line 200 of file FGPropertyManager.h.

    {
      SGPropertyNode* property = root->getNode(name.c_str(), true);
      if (!property) {
        std::cerr << "Could not get or create property " << name << std::endl;
        return;
      }
 
      if (!property->tie(SGRawValueFunctions<T>(getter, setter), false))
        std::cerr << "Failed to tie property " << name << " to functions"
                  << std::endl;
      else {
        tied_properties.push_back(PropertyState(property, nullptr));
        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Here is the call graph for this function:

Unbind() [1/3]

template<typename T >

void Unbind ( const std::shared_ptr< T > &  instance )

inline

Unbind all properties bound by this manager to an instance.

Classes should use this function to release control of any properties they have bound using this property manager. Helper function for shared_ptr

See also

Unbind(const void*)

Definition at line 155 of file FGPropertyManager.h.

                                                                        {
      Unbind(instance.get());
    }

Unbind() [2/3]

void Unbind

(

const void *

instance

)

Unbind all properties bound by this manager to an instance.

Classes should use this function to release control of any properties they have bound using this property manager.

Parameters

instance

The instance which properties shall be unbound.

Definition at line 64 of file FGPropertyManager.cpp.

{
  auto it = tied_properties.begin();
 
  while(it != tied_properties.end()) {
    auto property = it++;
    if (property->BindingInstance == instance) {
      property->untie();
      tied_properties.erase(property);
    }
  }
}

Unbind() [3/3]

void Unbind

(

void

)

Unbind all properties bound by this manager to an external data source.

Definition at line 54 of file FGPropertyManager.cpp.

{
  for(auto& property: tied_properties)
    property.untie();
 
  tied_properties.clear();
}

Untie() [1/2]

void Untie

(

const std::string &

name

)

Untie a property from an external data source.

Classes should use this function to release control of any properties they are managing.

Parameters

name	The property name to untie (full path).

Definition at line 145 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str());
  if (!property) {
    cerr << "Attempt to untie a non-existant property." << name << endl;
    return;
  }
 
  Untie(property);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Untie() [2/2]

void Untie

(

SGPropertyNode *

property

)

Untie a property from an external data source.

Classes should use this function to release control of any properties they are managing.

Parameters

property

A pointer to the property to untie.

Definition at line 158 of file FGPropertyManager.cpp.

{
  const string& name = property->getNameString();
 
  assert(property->isTied());
 
  for (auto it = tied_properties.begin(); it != tied_properties.end(); ++it) {
    if (it->node.ptr() == property) {
      it->untie();
      tied_properties.erase(it);
      if (FGJSBBase::debug_lvl & 0x20) cout << "Untied " << name << endl;
      return;
    }
  }
 
  cerr << "Failed to untie property " << name << endl
       << "JSBSim is not the owner of this property." << endl;
}

Here is the call graph for this function:

---

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

• FGPropertyManager.h
• FGPropertyManager.cpp