Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::BoolVisualDependencyXMLConverter Class Reference

An xml converter for BoolVisualDepenencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::BoolVisualDependencyXMLConverter:
Inheritance graph
[legend]

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
 

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

Detailed Description

An xml converter for BoolVisualDepenencies.

The valid XML representation of a BoolVisualDependency is:

<Dependency showIf="showIf value" type="BoolVisualDependency">
<Dependee parameterId="Id of dependee parameter"/>
<Dependent parameterId="Id of dependent parameter"/>
...Any other dependents...
This class represents a depndency between elements in a Parameter List.
Concrete serial communicator subclass.

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

Definition at line 283 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

◆ convertSpecialVisualAttributes() [1/2]

void Teuchos::BoolVisualDependencyXMLConverter::convertSpecialVisualAttributes ( RCP< const VisualDependency > dependency,
XMLObject & xmlObj,
const XMLParameterListWriter::EntryIDsMap & entryIDsMap ) const
virtual

◆ convertSpecialVisualAttributes() [2/2]

RCP< VisualDependency > Teuchos::BoolVisualDependencyXMLConverter::convertSpecialVisualAttributes ( const XMLObject & xmlObj,
const Dependency::ConstParameterEntryList dependees,
const Dependency::ParameterEntryList dependets,
bool showIf,
const XMLParameterListReader::EntryIDsMap & entryIDsMap ) const
virtual

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