SIM_RootData Class Reference
#include <SIM_RootData.h>
Public Member Functions | |
| const UT_String & | getName () const |
| bool | getMatchesString (const char *pattern) const |
| void | getRootDataId (SIM_RootDataId &id) const |
| Fills out the root data identifier by calling getRootDataIdSubclass(). | |
| void | appendFullDataPath (const SIM_Data *subdata, bool useobjectid, UT_String &datapath) const |
Static Public Member Functions | |
| static void | forceValidRootDataName (UT_String &rootdataname) |
Protected Member Functions | |
| SIM_RootData (const SIM_DataFactory *factory) | |
| virtual | ~SIM_RootData () |
| virtual bool | getMatchesStringSubclass (const char *pattern) const =0 |
| virtual void | getRootDataIdSubclass (SIM_RootDataId &id) const =0 |
Protected Attributes | |
| UT_String | myName |
Detailed Description
- Examples:
-
SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.
Definition at line 22 of file SIM_RootData.h.
Constructor & Destructor Documentation
| SIM_RootData::SIM_RootData | ( | const SIM_DataFactory * | factory | ) | [protected] |
| virtual SIM_RootData::~SIM_RootData | ( | ) | [protected, virtual] |
Member Function Documentation
| void SIM_RootData::appendFullDataPath | ( | const SIM_Data * | subdata, | |
| bool | useobjectid, | |||
| UT_String & | datapath | |||
| ) | const |
Returns the full path (including the path to this root data) for the specified subdata.
| static void SIM_RootData::forceValidRootDataName | ( | UT_String & | rootdataname | ) | [static] |
Forces the value of the passed in string to contain a value that represents a valid root data name. Currently valid root data names are the same as valid variable names.
| bool SIM_RootData::getMatchesString | ( | const char * | pattern | ) | const |
Determines if this root data is a match for the pattern string passed in. The string must be a single token, not a series of tokens, but wildcards are allowed. This function just calls getMatchesStringSubclass().
| virtual bool SIM_RootData::getMatchesStringSubclass | ( | const char * | pattern | ) | const [protected, pure virtual] |
This function returns whether this data matches the string pattern. This function must be overridden by subclasses.
Implemented in SIM_Object, and SIM_Relationship.
| const UT_String& SIM_RootData::getName | ( | ) | const |
Returns the name of the root data. The method for setting the name is provided in the subclasses because the rules for when and how this name can be set depends on the subclass type.
| void SIM_RootData::getRootDataId | ( | SIM_RootDataId & | id | ) | const |
Fills out the root data identifier by calling getRootDataIdSubclass().
| virtual void SIM_RootData::getRootDataIdSubclass | ( | SIM_RootDataId & | id | ) | const [protected, pure virtual] |
This function fills out the SIM_RootDataId structure with the unique identifier information for this root data.
Implemented in SIM_Object, and SIM_Relationship.
Member Data Documentation
UT_String SIM_RootData::myName [protected] |
Definition at line 61 of file SIM_RootData.h.
The documentation for this class was generated from the following file:
- SIM/SIM_RootData.h
