Detailed Description

Class wrapper for property handling.

Author: David Megginson, Tony Peden

Definition at line 72 of file FGPropertyManager.h.

#include <FGPropertyManager.h>

Inheritance diagram for FGPropertyNode:

Collaboration diagram for FGPropertyNode:

Public Member Functions
virtual	~FGPropertyNode (void)
	Destructor.

bool	GetBool (const std::string &name, bool defaultValue=false) const
	Get a bool value for a property. More...

double	GetDouble (const std::string &name, double defaultValue=0.0) const
	Get a double value for a property. More...

float	GetFloat (const std::string &name, float defaultValue=0.0) const
	Get a float value for a property. More...

std::string	GetFullyQualifiedName (void) const
	Get the fully qualified name of a node This function is very slow, so is probably useful for debugging only.

int	GetInt (const std::string &name, int defaultValue=0) const
	Get an int value for a property. More...

int	GetLong (const std::string &name, long defaultValue=0L) const
	Get a long value for a property. More...

const std::string &	GetName (void) const
	Get the name of a node.

FGPropertyNode *	GetNode (const std::string &path, bool create=false)
	Get a property node. More...

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

std::string	GetPrintableName (void) const
	Get the name of a node without underscores, etc.

std::string	GetRelativeName (const std::string &path="/fdm/jsbsim/") const
	Get the qualified name of a node relative to given base path, otherwise the fully qualified name. More...

std::string	GetString (const std::string &name, std::string defaultValue="") const
	Get a string value for a property. More...

bool	HasNode (const std::string &path)
	Test whether a given node exists. More...

void	SetArchivable (const std::string &name, bool state=true)
	Set the state of the archive attribute for a property. More...

bool	SetBool (const std::string &name, bool val)
	Set a bool value for a property. More...

bool	SetDouble (const std::string &name, double val)
	Set a double value for a property. More...

bool	SetFloat (const std::string &name, float val)
	Set a float value for a property. More...

bool	SetInt (const std::string &name, int val)
	Set an int value for a property. More...

bool	SetLong (const std::string &name, long val)
	Set a long value for a property. More...

void	SetReadable (const std::string &name, bool state=true)
	Set the state of the read attribute for a property. More...

bool	SetString (const std::string &name, const std::string &val)
	Set a string value for a property. More...

void	SetWritable (const std::string &name, bool state=true)
	Set the state of the write attribute for a property. More...

Member Function Documentation

◆ GetBool()

bool GetBool	(	const std::string &	name,
		bool	defaultValue = `false`
	)		const

Get a bool value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getBoolValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as a bool, or the default value provided.

Definition at line 180 of file FGPropertyManager.cpp.

 {
   return getBoolValue(name.c_str(), defaultValue);
 }

◆ GetDouble()

double GetDouble	(	const std::string &	name,
		double	defaultValue = `0.0`
	)		const

Get a double value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getDoubleValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as a double, or the default value provided.

Definition at line 208 of file FGPropertyManager.cpp.

 {
   return getDoubleValue(name.c_str(), defaultValue);
 }

Here is the caller graph for this function:

◆ GetFloat()

float GetFloat	(	const std::string &	name,
		float	defaultValue = `0.0`
	)		const

Get a float value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getFloatValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as a float, or the default value provided.

Definition at line 201 of file FGPropertyManager.cpp.

 {
   return getFloatValue(name.c_str(), defaultValue);
 }

◆ GetInt()

int GetInt	(	const std::string &	name,
		int	defaultValue = `0`
	)		const

Get an int value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getIntValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as an int, or the default value provided.

Definition at line 187 of file FGPropertyManager.cpp.

 {
   return getIntValue(name.c_str(), defaultValue);
 }

◆ GetLong()

int GetLong	(	const std::string &	name,
		long	defaultValue = `0L`
	)		const

Get a long value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getLongValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as a long, or the default value provided.

Definition at line 194 of file FGPropertyManager.cpp.

 {
   return getLongValue(name.c_str(), defaultValue);
 }

◆ GetNode()

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

Get a property node.

Parameters

path	The path of the node, relative to root.
create	true to create the node if it doesn't exist.

Returns: The node, or 0 if none exists and none was created.

Definition at line 97 of file FGPropertyManager.cpp.

 {
   SGPropertyNode* node = getNode(path.c_str(), create);
   if (node == 0) {
     cerr << "FGPropertyManager::GetNode() No node found for " << path << endl;
   }
   return (FGPropertyNode*)node;
 }

Here is the caller graph for this function:

◆ GetRelativeName()

string GetRelativeName ( const std::string & path = "/fdm/jsbsim/" ) const

Get the qualified name of a node relative to given base path, otherwise the fully qualified name.

This function is very slow, so is probably useful for debugging only.

Parameters

path	The path to strip off, if found.

Definition at line 166 of file FGPropertyManager.cpp.

 {
   string temp_string = GetFullyQualifiedName();
   size_t len = path.length();
   if ( (len > 0) && (temp_string.substr(0,len) == path) ) {
     temp_string = temp_string.erase(0,len);
   }
   return temp_string;
 }

◆ GetString()

string GetString	(	const std::string &	name,
		std::string	defaultValue = `""`
	)		const

Get a string value for a property.

This method is convenient but inefficient. It should be used infrequently (i.e. for initializing, loading, saving, etc.), not in the main loop. If you need to get a value frequently, it is better to look up the node itself using GetNode and then use the node's getStringValue() method, to avoid the lookup overhead.

Parameters

name	The property name.
defaultValue	The default value to return if the property does not exist.

Returns: The property's value as a string, or the default value provided.

Definition at line 215 of file FGPropertyManager.cpp.

 {
   return string(getStringValue(name.c_str(), defaultValue.c_str()));
 }

◆ HasNode()

bool HasNode ( const std::string & path )

Test whether a given node exists.

Parameters

path	The path of the node, relative to root.

Returns: true if the node exists, false otherwise.

Definition at line 121 of file FGPropertyManager.cpp.

 {
   const SGPropertyNode* node = getNode(path.c_str(), false);
   return (node != 0);
 }

◆ SetArchivable()

void SetArchivable	(	const std::string &	name,
		bool	state = `true`
	)

Set the state of the archive attribute for a property.

If the archive attribute is true, the property will be written when a flight is saved; if it is false, the property will be skipped.

A warning message will be printed if the property does not exist.

Parameters

name	The property name.
state	The state of the archive attribute (defaults to true).

Definition at line 264 of file FGPropertyManager.cpp.

 {
   SGPropertyNode * node = getNode(name.c_str());
   if (node == 0)
     cerr <<
            "Attempt to set archive flag for non-existent property "
            << name << endl;
   else
     node->setAttribute(SGPropertyNode::ARCHIVE, state);
 }

◆ SetBool()

bool SetBool	(	const std::string &	name,
		bool	val
	)

Set a bool value for a property.

Assign a bool value to a property. If the property does not yet exist, it will be created and its type will be set to BOOL; if it has a type of UNKNOWN, the type will also be set to BOOL; otherwise, the value type will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 222 of file FGPropertyManager.cpp.

 {
   return setBoolValue(name.c_str(), val);
 }

◆ SetDouble()

bool SetDouble	(	const std::string &	name,
		double	val
	)

Set a double value for a property.

Assign a double value to a property. If the property does not yet exist, it will be created and its type will be set to DOUBLE; if it has a type of UNKNOWN, the type will also be set to DOUBLE; otherwise, the double value will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 250 of file FGPropertyManager.cpp.

 {
   return setDoubleValue(name.c_str(), val);
 }

◆ SetFloat()

bool SetFloat	(	const std::string &	name,
		float	val
	)

Set a float value for a property.

Assign a float value to a property. If the property does not yet exist, it will be created and its type will be set to FLOAT; if it has a type of UNKNOWN, the type will also be set to FLOAT; otherwise, the value type will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 243 of file FGPropertyManager.cpp.

 {
   return setFloatValue(name.c_str(), val);
 }

◆ SetInt()

bool SetInt	(	const std::string &	name,
		int	val
	)

Set an int value for a property.

Assign an int value to a property. If the property does not yet exist, it will be created and its type will be set to INT; if it has a type of UNKNOWN, the type will also be set to INT; otherwise, the value type will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 229 of file FGPropertyManager.cpp.

 {
   return setIntValue(name.c_str(), val);
 }

◆ SetLong()

bool SetLong	(	const std::string &	name,
		long	val
	)

Set a long value for a property.

Assign a long value to a property. If the property does not yet exist, it will be created and its type will be set to LONG; if it has a type of UNKNOWN, the type will also be set to LONG; otherwise, the value type will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 236 of file FGPropertyManager.cpp.

 {
   return setLongValue(name.c_str(), val);
 }

◆ SetReadable()

void SetReadable	(	const std::string &	name,
		bool	state = `true`
	)

Set the state of the read attribute for a property.

If the read attribute is true, the property value will be readable; if it is false, the property value will always be the default value for its type.

A warning message will be printed if the property does not exist.

Parameters

name	The property name.
state	The state of the read attribute (defaults to true).

Definition at line 277 of file FGPropertyManager.cpp.

 {
   SGPropertyNode * node = getNode(name.c_str());
   if (node == 0)
     cerr <<
            "Attempt to set read flag for non-existant property "
            << name << endl;
   else
     node->setAttribute(SGPropertyNode::READ, state);
 }

◆ SetString()

bool SetString	(	const std::string &	name,
		const std::string &	val
	)

Set a string value for a property.

Assign a string value to a property. If the property does not yet exist, it will be created and its type will be set to STRING; if it has a type of UNKNOWN, the type will also be set to STRING; otherwise, the string value will be converted to the property's type.

Parameters

name	The property name.
val	The new value for the property.

Returns: true if the assignment succeeded, false otherwise.

Definition at line 257 of file FGPropertyManager.cpp.

 {
   return setStringValue(name.c_str(), val.c_str());
 }

◆ SetWritable()

void SetWritable	(	const std::string &	name,
		bool	state = `true`
	)

Set the state of the write attribute for a property.

If the write attribute is true, the property value may be modified (depending on how it is tied); if the write attribute is false, the property value may not be modified.

A warning message will be printed if the property does not exist.

Parameters

name	The property name.
state	The state of the write attribute (defaults to true).

Definition at line 290 of file FGPropertyManager.cpp.

 {
   SGPropertyNode * node = getNode(name.c_str());
   if (node == 0)
     cerr <<
            "Attempt to set write flag for non-existant property "
            << name << endl;
   else
     node->setAttribute(SGPropertyNode::WRITE, state);
 }

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

Detailed Description

Public Member Functions

Member Function Documentation

◆ GetBool()

◆ GetDouble()

◆ GetFloat()

◆ GetInt()

◆ GetLong()

◆ GetNode()

◆ GetRelativeName()

◆ GetString()

◆ HasNode()

◆ SetArchivable()

◆ SetBool()

◆ SetDouble()

◆ SetFloat()

◆ SetInt()

◆ SetLong()

◆ SetReadable()

◆ SetString()

◆ SetWritable()