FGPropertyManager Class Reference

Public Member Functions
	FGPropertyManager (void)
	Default constructor.
	FGPropertyManager (FGPropertyNode *_root)
	Constructor.
virtual	~FGPropertyManager (void)
	Destructor.
template<class T >
simgear::PropertyObject< T >	CreatePropertyObject (const std::string &path)
FGPropertyNode *	GetNode (void) const
FGPropertyNode *	GetNode (const std::string &path, bool create=false)
FGPropertyNode *	GetNode (const std::string &relpath, int index, bool create=false)
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. More...
void	Tie (const std::string &name, bool *pointer, bool useDefault=true)
	Tie a property to an external bool variable. More...
void	Tie (const std::string &name, int *pointer, bool useDefault=true)
	Tie a property to an external int variable. More...
void	Tie (const std::string &name, long *pointer, bool useDefault=true)
	Tie a property to an external long variable. More...
void	Tie (const std::string &name, float *pointer, bool useDefault=true)
	Tie a property to an external float variable. More...
void	Tie (const std::string &name, double *pointer, bool useDefault=true)
	Tie a property to an external double variable. More...
template<class V >
void	Tie (const std::string &name, V(*getter)(), void(*setter)(V)=0, bool useDefault=true)
	Tie a property to a pair of simple functions. More...
template<class V >
void	Tie (const std::string &name, int index, V(*getter)(int), void(*setter)(int, V)=0, bool useDefault=true)
	Tie a property to a pair of indexed functions. More...
template<class T , class V >
void	Tie (const std::string &name, T *obj, V(T::*getter)() const, void(T::*setter)(V)=0, bool useDefault=true)
	Tie a property to a pair of object methods. More...
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)=0, bool useDefault=true)
	Tie a property to a pair of indexed object methods. More...
void	Unbind (void)
	Unbind all properties bound by this manager to an external data source. More...
void	Untie (const std::string &name)
	Untie a property from an external data source. More...

Detailed Description

Definition at line 379 of file FGPropertyManager.h.

Member Function Documentation

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 65 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;
}

Here is the caller graph for this function:

Tie() [1/9]

void Tie	(	const std::string &	name,
		bool *	pointer,
		bool	useDefault = true
	)

Tie a property to an external bool 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.
useDefault	true if any existing property value should be copied to the variable; false if the variable should not be modified; defaults to true.

Definition at line 330 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str(), true);
  if (!property) {
    cerr << "Could not get or create property " << name << endl;
    return;
  }

  if (!property->tie(SGRawValuePointer<bool>(pointer), useDefault))
    cerr << "Failed to tie property " << name << " to a pointer" << endl;
  else {
    tied_properties.push_back(property);
    if (FGJSBBase::debug_lvl & 0x20) cout << name << endl;
  }
}

Here is the caller graph for this function:

Tie() [2/9]

void Tie	(	const std::string &	name,
		int *	pointer,
		bool	useDefault = true
	)

Tie a property to an external int 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.
useDefault	true if any existing property value should be copied to the variable; false if the variable should not be modified; defaults to true.

Definition at line 348 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str(), true);
  if (!property) {
    cerr << "Could not get or create property " << name << endl;
    return;
  }

  if (!property->tie(SGRawValuePointer<int>(pointer), useDefault))
    cerr << "Failed to tie property " << name << " to a pointer" << endl;
  else {
    tied_properties.push_back(property);
    if (FGJSBBase::debug_lvl & 0x20) cout << name << endl;
  }
}

Tie() [3/9]

void Tie	(	const std::string &	name,
		long *	pointer,
		bool	useDefault = true
	)

Tie a property to an external long 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.
useDefault	true if any existing property value should be copied to the variable; false if the variable should not be modified; defaults to true.

Definition at line 367 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str(), true);
  if (!property) {
    cerr << "Could not get or create property " << name << endl;
    return;
  }

  if (!property->tie(SGRawValuePointer<long>(pointer), useDefault))
    cerr << "Failed to tie property " << name << " to a pointer" << endl;
  else {
    tied_properties.push_back(property);
    if (FGJSBBase::debug_lvl & 0x20) cout << name << endl;
  }
}

Tie() [4/9]

void Tie	(	const std::string &	name,
		float *	pointer,
		bool	useDefault = true
	)

Tie a property to an external float 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.
useDefault	true if any existing property value should be copied to the variable; false if the variable should not be modified; defaults to true.

Definition at line 386 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str(), true);
  if (!property) {
    cerr << "Could not get or create property " << name << endl;
    return;
  }

  if (!property->tie(SGRawValuePointer<float>(pointer), useDefault))
    cerr << "Failed to tie property " << name << " to a pointer" << endl;
  else {
    tied_properties.push_back(property);
    if (FGJSBBase::debug_lvl & 0x20) cout << name << endl;
  }
}

Tie() [5/9]

void Tie	(	const std::string &	name,
		double *	pointer,
		bool	useDefault = true
	)

Tie a property to an external double 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.
useDefault	true if any existing property value should be copied to the variable; false if the variable should not be modified; defaults to true.

Definition at line 405 of file FGPropertyManager.cpp.

{
  SGPropertyNode* property = root->getNode(name.c_str(), true);
  if (!property) {
    cerr << "Could not get or create property " << name << endl;
    return;
  }

  if (!property->tie(SGRawValuePointer<double>(pointer), useDefault))
    cerr << "Failed to tie property " << name << " to a pointer" << endl;
  else {
    tied_properties.push_back(property);
    if (FGJSBBase::debug_lvl & 0x20) cout << name << endl;
  }
}

Tie() [6/9]

void Tie ( const std::string &  name, V(*)()  getter, void(*)(V)  setter = 0, bool  useDefault = true  )

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.
useDefault	true if the setter should be invoked with any existing property value should be; false if the old value should be discarded; defaults to true.

Definition at line 555 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<V>(getter, setter), useDefault))
        std::cerr << "Failed to tie property " << name << " to functions" << std::endl;
      else {
        if (setter == 0) property->setAttribute(SGPropertyNode::WRITE, false);
        if (getter == 0) property->setAttribute(SGPropertyNode::READ, false);
        tied_properties.push_back(property);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Tie() [7/9]

void Tie ( const std::string &  name, int  index, V(*)(int)  getter, void(*)(int, V)  setter = 0, bool  useDefault = true  )

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.
useDefault	true if the setter should be invoked with any existing property value should there be one; false if the old value should be discarded; defaults to true.

Definition at line 592 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<V>(index, getter, setter), useDefault))
        std::cerr << "Failed to tie property " << name << " to indexed functions" << std::endl;
      else {
        if (setter == 0) property->setAttribute(SGPropertyNode::WRITE, false);
        if (getter == 0) property->setAttribute(SGPropertyNode::READ, false);
        tied_properties.push_back(property);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Tie() [8/9]

void Tie ( const std::string &  name, T *  obj, V(T::*)() const  getter, void(T::*)(V)  setter = 0, bool  useDefault = true  )

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.
useDefault	true if the setter should be invoked with any existing property value should there be one; false if the old value should be discarded; defaults to true.

Definition at line 632 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), useDefault))
        std::cerr << "Failed to tie property " << name << " to object methods" << std::endl;
      else {
        if (setter == 0) property->setAttribute(SGPropertyNode::WRITE, false);
        if (getter == 0) property->setAttribute(SGPropertyNode::READ, false);
        tied_properties.push_back(property);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
    }

Tie() [9/9]

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

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.
useDefault	true if the setter should be invoked with any existing property value should be; false if the old value should be discarded; defaults to true.

Definition at line 671 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), useDefault))
        std::cerr << "Failed to tie property " << name << " to indexed object methods" << std::endl;
      else {
        if (setter == 0) property->setAttribute(SGPropertyNode::WRITE, false);
        if (getter == 0) property->setAttribute(SGPropertyNode::READ, false);
        tied_properties.push_back(property);
        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
      }
   }

Unbind()

void Unbind

(

void

)

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

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

Definition at line 53 of file FGPropertyManager.cpp.

{
    vector<SGPropertyNode_ptr>::iterator it;

    for (it = tied_properties.begin();it < tied_properties.end();it++)
        (*it)->untie();

    tied_properties.clear();
}

Untie()

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.

Definition at line 306 of file FGPropertyManager.cpp.

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

  vector <SGPropertyNode_ptr>::iterator it;
  for (it = tied_properties.begin(); it != tied_properties.end(); ++it) {
    if (*it == property) {
      property->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;
}

---

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

• FGPropertyManager.h
• FGPropertyManager.cpp