Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::StringVisualDependencyXMLConverter Class Reference

An xml converter for StringVisualDepenencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::StringVisualDependencyXMLConverter:
Teuchos::VisualDependencyXMLConverter Teuchos::DependencyXMLConverter Teuchos::Describable Teuchos::LabeledObject

Overridden from VisualDependencyConverter

void convertSpecialVisualAttributes (RCP< const VisualDependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
 
RCP< VisualDependencyconvertSpecialVisualAttributes (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, bool showIf, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const
 
static const std::string & getStringValuesTagName ()
 Gets the StringValues Tag. More...
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::VisualDependencyXMLConverter
RCP< DependencyconvertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 
void convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 
- Public Member Functions inherited from Teuchos::DependencyXMLConverter
RCP< DependencyfromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a Dependency. More...
 
XMLObject fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 Converters a given ParameterEntryValidator to XML. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 
- Static Public Member Functions inherited from Teuchos::DependencyXMLConverter
static const std::string & getDependeeTagName ()
 Returns the string to be used for the dependee tag. More...
 
static const std::string & getDependentTagName ()
 Returns the string to be used for the dependent tag. More...
 
static const std::string & getParameterIdAttributeName ()
 Returns the string to be used for the ParameterID attribute. More...
 
static const std::string & getTypeAttributeName ()
 Returns the string to be used for the type attribute. More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

An xml converter for StringVisualDepenencies.

The valid XML representation of a StringVisualDependency is:

<Dependency showIf="showIf value" type="StringVisualDependency">
<Dependee parameterId="Id of dependee parameter"/>
<Dependent parameterId="Id of dependent parameter"/>
...Any addiditional Dependents...
<StringValues>
<String value="First value"/>
<String value="Second value"/>
...Other Values...
</StringValues>
</Dependency>

The "showIf" XML attribute is optional and if not present will be considered true.

Definition at line 188 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

void Teuchos::StringVisualDependencyXMLConverter::convertSpecialVisualAttributes ( RCP< const VisualDependency dependency,
XMLObject xmlObj,
const XMLParameterListWriter::EntryIDsMap entryIDsMap 
) const
virtual
RCP< VisualDependency > Teuchos::StringVisualDependencyXMLConverter::convertSpecialVisualAttributes ( const XMLObject xmlObj,
const Dependency::ConstParameterEntryList  dependees,
const Dependency::ParameterEntryList  dependets,
bool  showIf,
const XMLParameterListReader::EntryIDsMap entryIDsMap 
) const
virtual
static const std::string& Teuchos::StringVisualDependencyXMLConverter::getStringValuesTagName ( )
inlinestatic

Gets the StringValues Tag.

Definition at line 210 of file Teuchos_StandardDependencyXMLConverters.hpp.


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