Allows applications to translate Xml label files. More...

#include <XmlToPvlTranslationManager.h>

Inheritance diagram for Isis::XmlToPvlTranslationManager:

Collaboration diagram for Isis::XmlToPvlTranslationManager:

Public Member Functions
	XmlToPvlTranslationManager (const QString &transFile)
	Constructs and initializes an XmlToPvlTranslationManager object from the given Pvl translation file. More...

	XmlToPvlTranslationManager (std::istream &transStrm)
	Constructs and initializes an XmlToPvlTranslationManager object from the given input stream. More...

	XmlToPvlTranslationManager (FileName &inputLabel, const QString &transFile)
	Constructs and initializes an XmlToPvlTranslationManager object from the given Pvl translation file and input label. More...

	XmlToPvlTranslationManager (FileName &inputLabel, std::istream &transStrm)
	Constructs and initializes an XmlToPvlTranslationManager object from the given input stream and input label. More...

virtual	~XmlToPvlTranslationManager ()
	Destroys the XmlToPvlTranslationManager object. More...

virtual QString	Translate (QString translationGroupName, int findex=0)
	Returns a translated value. More...

void	Auto (FileName &inputLabel, Pvl &outputLabel)
	Automatically translate all the output names flagged with the Auto keyword in the translation table and store the translated key, value pairs in the argument pvl. More...

void	SetLabel (FileName &inputLabel)
	Reads an Xml label file and internalizes it for translation. More...

virtual void	Auto (Pvl &outputLabel)
	Automatically translate all the output names tagged as Auto in the translation table If a output name does not translate an error will be thrown by one of the support members. More...

QString	Translate (const QString translationGroupName, const QString inputKeyValue="") const
	Translates a single output value from the given translation group name and input value. More...

virtual void	Auto (Pvl &outputLabel)
	Automatically translate all the output names tagged as Auto in the translation table If a output name does not translate an error will be thrown by one of the support members. More...

virtual QStringList	parseSpecification (QString specification) const
	Parses and validates a dependency specification. More...

virtual PvlKeyword	InputGroup (const QString translationGroupName, const int inst=0) const
	Returns the input group name from the translation table corresponding to the output name argument. More...

virtual QString	InputKeywordName (const QString translationGroupName) const
	Returns the input keyword name from the translation table corresponding to the output name argument. More...

QString	InputDefault (const QString translationGroupName) const
	Returns the input default value from the translation table corresponding to the output name argument. More...

void	AddTable (std::istream &transStm)
	Adds the contents of a translation table to the searchable groups/keys Also performs a verification, to ensure that the translation table is valid. More...

void	AddTable (const QString &transFile)
	Adds the contents of a translation table to the searchable groups/keys. More...

Protected Member Functions
virtual std::vector< std::pair< QString, int > >	validKeywords () const
	Returns a vector of valid keyword names and their sizes. More...

bool	checkDependencies (QDomElement element, PvlKeyword dependencies, bool isDebug) const
	Checks if a element in the xml label satisfies a list of dependencies. More...

void	parseFile (const FileName &xmlFileName)
	Opens, parses, and internalizes an Xml label file. More...

virtual PvlKeyword	DoTranslation (const QString translationGroupName)
	Translate the requested output name to output values using the input name and values or default value. More...

virtual PvlContainer *	CreateContainer (const QString translationGroupName, Pvl &pvl)
	Creates all parent PVL containers for an output keyword. More...

Pvl &	TranslationTable ()
	Protected accessor for pvl translation table passed into class. More...

const Pvl &	TranslationTable () const
	Protected accessor for const pvl translation table passed into class. More...

bool	hasInputDefault (const QString translationGroupName)
	Determines whether the given group has a default input value. More...

bool	IsAuto (const QString translationGroupName)
	Determines whether the given group should be automatically translated. More...

bool	IsOptional (const QString translationGroupName)
	Determines whether the translation group is optional. More...

PvlKeyword	OutputPosition (const QString translationGroupName)
	Retrieves the OutputPosition PvlKeyword for the translation group with the given name. More...

QString	OutputName (const QString translationGroupName)
	Retrieves a string containing the value of the OutputName keyword for the translation group with the given name. More...

const PvlGroup &	findTranslationGroup (const QString translationGroupName) const
	Searches for translation group with the given name. More...

Private Attributes
QDomDocument	m_xmlLabel
	The contents of the xml label. More...

Detailed Description

Allows applications to translate Xml label files.

This class allows for translating Xml label files into Pvl objects. The translation process is driven by the output keyword names. Given an output keyword name, the Translate method uses the translation table to find the input value and then translates it into the output value.

The translation table is a Pvl object containing a Pvl group for each output keyword. The translation group for an output keyword is named the output keyword's name. The required PvlKeywords in a translation group are:

InputPosition: The series of element tag names leading from the second highest level element to the parent element of the input element.
InputKey: The tag name of the input element. The text value of this element is the input value for the translation.
OutputName: The output keyword's name.
OutputPosition: The location of the output keyword in the output label.
Translation: a pair defining how to convert the input value into the output value. The pair is consists of an output value and then the specific input value that will be converted into that output value. A star [*] for the output value indicates that the input value will not be changes and a star [*] for the input value matches any input value.

There are also optional keywords to modify the translation:

InputDefault: A default value that will be used for the input value if no input value can be found in the label.
Auto: The Auto keyword is not associated with a value. It indicates that the output keyword should be translated when the Auto() method is called.
Optional: The Optional keyword is not associated with a value. It indicates that the output keyword is not necessary. If an input value or default value is not found for an optional keyword, it will be skipped and translation will continue.
Debug: The Debug keyword is not associated with a value. It indicates that debug information is to be output when the translation is performed.
InputKeyAttribute: The name of the attribute of the input element that the input value will be read from. This will override reading the input value from the input element's text.
InputKeyDependencies: A list of dependencies that uniquely identify the input element. Each entry consists of a string specifying either the text value of a sibling element of the input element or the value of one of the input element's attributes. The specification string is formatted as TYPE@NAME:VALUE. The type is either tag or att indicating to check the value of an element of attribute respectively.

An example Xml translation table can be found at $base/translations/XmlLabel.trn.

Author: 2017-01-12 Jeannie Backer

History:

2017-01-12 Jeannie Backer - Original version. Adapted from PvlTranslationManager class. Fixes #4584.

2017-01-13 Jeannie Backer and Jesse Mapel - Initial Translate and Auto design. Added dependencies for uniquely identifying input elements. Fixes #4584.

2017-01-18 Jesse Mapel - Updated documentation and error messages. Fixes #4584.

2017-01-25 Jesse Mapel - Created unit test. Fixes #4584.

2017-05-26 Makayla Shepherd - Renamed XmlToPvlTranslationManager.

2018-02-15 Kristin Berry and Summer Stapleton - Updated translate() method to search for multiple values for InputPosition keyword. Fixes #5332

2018-04-16 Jeannie Backer - Improved error message for keyword dependencies.

Definition at line 130 of file XmlToPvlTranslationManager.h.

Constructor & Destructor Documentation

◆ XmlToPvlTranslationManager() [1/4]

Isis::XmlToPvlTranslationManager::XmlToPvlTranslationManager ( const QString & transFile )

Constructs and initializes an XmlToPvlTranslationManager object from the given Pvl translation file.

If this constructor is used, the user will need to set the input label before translating. This may be done by using SetLabel(FileName inputLabel) or Auto(FileName inputLabel, Pvl outputLabel).

Parameters

transFile The translation file to be used to tranlate keywords in the input label.

Definition at line 54 of file XmlToPvlTranslationManager.cpp.

References Isis::PvlTranslationTable::AddTable().

◆ XmlToPvlTranslationManager() [2/4]

Isis::XmlToPvlTranslationManager::XmlToPvlTranslationManager ( std::istream & transStrm )

Constructs and initializes an XmlToPvlTranslationManager object from the given input stream.

If this constructor is used, the user will need to set the input label before translating. This may be done by using SetLabel(FileName inputLabel) or Auto(FileName inputLabel, Pvl outputLabel).

Parameters

transStrm A stream containing the tranlation table to be used to tranlate keywords in the input label.

Definition at line 70 of file XmlToPvlTranslationManager.cpp.

References Isis::PvlTranslationTable::AddTable().

◆ XmlToPvlTranslationManager() [3/4]

Isis::XmlToPvlTranslationManager::XmlToPvlTranslationManager	(	FileName &	inputLabel,
		const QString &	transFile
	)

Constructs and initializes an XmlToPvlTranslationManager object from the given Pvl translation file and input label.

Parameters

inputLabel	The Xml holding the input label.
transFile	The translation file to be used to tranlate keywords in the input label.

Definition at line 85 of file XmlToPvlTranslationManager.cpp.

References Isis::PvlTranslationTable::AddTable(), and parseFile().

◆ XmlToPvlTranslationManager() [4/4]

Isis::XmlToPvlTranslationManager::XmlToPvlTranslationManager	(	FileName &	inputLabel,
		std::istream &	transStrm
	)

Constructs and initializes an XmlToPvlTranslationManager object from the given input stream and input label.

Parameters

inputLabel	The Xml holding the input label.
transStrm	A stream containing the tranlation table to be used to tranlate keywords in the input label.

Definition at line 102 of file XmlToPvlTranslationManager.cpp.

References Isis::PvlTranslationTable::AddTable(), and parseFile().

◆ ~XmlToPvlTranslationManager()

Isis::XmlToPvlTranslationManager::~XmlToPvlTranslationManager ( )

virtual

Destroys the XmlToPvlTranslationManager object.

Definition at line 113 of file XmlToPvlTranslationManager.cpp.

Member Function Documentation

◆ AddTable() [1/2]

void Isis::PvlTranslationTable::AddTable ( std::istream & transStm )

inherited

Adds the contents of a translation table to the searchable groups/keys Also performs a verification, to ensure that the translation table is valid.

Parameters

transStm The stream to be added.

Exceptions

IException::User	- "Unable to find InputKey for group in translation file."
IException::User	- "Keyword is not valid. Error in file."
IException::User	- "Keyword does not have correct number of elements. Error in file."

Definition at line 118 of file PvlTranslationTable.cpp.

References _FILEINFO_, Isis::PvlContainer::hasKeyword(), Isis::PvlContainer::keywords(), Isis::PvlContainer::name(), Isis::PvlKeyword::name(), and Isis::PvlKeyword::size().

Referenced by Isis::LabelTranslationManager::LabelTranslationManager(), and XmlToPvlTranslationManager().

◆ AddTable() [2/2]

void Isis::PvlTranslationTable::AddTable ( const QString & transFile )

inherited

Adds the contents of a translation table to the searchable groups/keys.

Parameters

transFile The name of the translation file to be added.

Definition at line 100 of file PvlTranslationTable.cpp.

References Isis::Pvl::read().

◆ Auto() [1/3]

void Isis::LabelTranslationManager::Auto ( Pvl & outputLabel )

virtualinherited

Automatically translate all the output names tagged as Auto in the translation table If a output name does not translate an error will be thrown by one of the support members.

The results of the translations will be stored in the outputLabel PVL based on the OutputPosition keywords in the translation table.

Parameters

outputLabel The PVL to add the translated keywords to.

Reimplemented in Isis::PvlToPvlTranslationManager.

Definition at line 85 of file LabelTranslationManager.cpp.

References Isis::LabelTranslationManager::CreateContainer(), Isis::LabelTranslationManager::DoTranslation(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::PvlContainer::name(), and Isis::PvlTranslationTable::TranslationTable().

◆ Auto() [2/3]

void Isis::LabelTranslationManager::Auto

Automatically translate all the output names tagged as Auto in the translation table If a output name does not translate an error will be thrown by one of the support members.

The results of the translations will be stored in the outputLabel PVL based on the OutputPosition keywords in the translation table.

Parameters

outputLabel The PVL to add the translated keywords to.

Definition at line 85 of file LabelTranslationManager.cpp.

◆ Auto() [3/3]

void Isis::XmlToPvlTranslationManager::Auto	(	FileName &	inputLabel,
		Pvl &	outputLabel
	)

Automatically translate all the output names flagged with the Auto keyword in the translation table and store the translated key, value pairs in the argument pvl.

Parameters

inputLabel	The input label file to be translated.
outputLabel	The output translated Pvl.

Definition at line 464 of file XmlToPvlTranslationManager.cpp.

References parseFile().

◆ checkDependencies()

bool Isis::XmlToPvlTranslationManager::checkDependencies	(	QDomElement	element,
		PvlKeyword	dependencies,
		bool	isDebug
	)		const

protected

Checks if a element in the xml label satisfies a list of dependencies.

Checks if a element in the xml label satisfies a list of dependencies. The dependencies are requirements on the values of attributes of the element and/or the values of sibling elements. The dependencies are specified by strings that are formatted as follows [tag/att]@[tagName/attName]|[value] or [tagName/attName]|[value]

Parameters

element	The element to check dependencies on.
dependencies	A multi-valued keyword were every entry specifies a requirement upon either an attribute of the element or a sibling of the element.

Returns: bool If the element passed the dependencies check

Exceptions

IException::Unknown "Parsing error, dependency type is not [att] or [tag]."

Definition at line 387 of file XmlToPvlTranslationManager.cpp.

References _FILEINFO_, Isis::LabelTranslationManager::parseSpecification(), Isis::PvlKeyword::size(), Isis::toString(), and Isis::IException::Unknown.

Referenced by Translate().

◆ CreateContainer()

PvlContainer * Isis::LabelTranslationManager::CreateContainer	(	const QString	translationGroupName,
		Pvl &	pvl
	)

protectedvirtualinherited

Creates all parent PVL containers for an output keyword.

If any parent containers already exist then they will not be recreated.

Parameters

translationGroupName	The name of the output keyword. The OutputPosition keyword in the translation group for translationGroupName will be used to determine which containers are made.
pvl	The PVL file to create the containers in.

Returns: PvlContainer The immediate parent container for translationGroupName.

Reimplemented in Isis::PvlToPvlTranslationManager.

Definition at line 115 of file LabelTranslationManager.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlObject::addObject(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlObject::hasObject(), Isis::PvlTranslationTable::OutputPosition(), and Isis::PvlKeyword::size().

Referenced by Isis::LabelTranslationManager::Auto(), and Isis::PvlToPvlTranslationManager::CreateContainer().

◆ DoTranslation()

PvlKeyword Isis::LabelTranslationManager::DoTranslation ( const QString outputName )

protectedvirtualinherited

Translate the requested output name to output values using the input name and values or default value.

Parameters

outputName The output name used to identify the input keyword to be translated.

Returns: PvlKeyword A keyword containing the output name and output value.

output units

Reimplemented in Isis::PvlToPvlTranslationManager.

Definition at line 159 of file LabelTranslationManager.cpp.

Referenced by Isis::LabelTranslationManager::Auto().

◆ findTranslationGroup()

const PvlGroup & Isis::PvlTranslationTable::findTranslationGroup ( const QString translationGroupName ) const

protectedinherited

Searches for translation group with the given name.

See also: PvlObject::findGroup()

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: const PvlGroup& The first PVL group with the given name.

Exceptions

IException::Programmer - "Unable to find translation group in file."

Definition at line 554 of file PvlTranslationTable.cpp.

References _FILEINFO_, and Isis::PvlContainer::fileName().

◆ hasInputDefault()

bool Isis::PvlTranslationTable::hasInputDefault ( const QString translationGroupName )

protectedinherited

Determines whether the given group has a default input value.

This method returns true if the translation group contains a PvlKeyword with the name "InputDefault". Note: no value needs to be assigned to this keyword.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: bool Indicates whether the given group has an InputDefault keyword.

Definition at line 423 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Translate().

◆ InputDefault()

QString Isis::PvlTranslationTable::InputDefault ( const QString translationGroupName ) const

inherited

Returns the input default value from the translation table corresponding to the output name argument.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: QString The input default value.

Definition at line 398 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Translate().

◆ InputGroup()

PvlKeyword Isis::PvlTranslationTable::InputGroup	(	const QString	translationGroupName,
		const int	inst = `0`
	)		const

virtualinherited

Returns the input group name from the translation table corresponding to the output name argument.

Parameters

translationGroupName	The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.
inst	The occurence number of the "InputGroup" keyword (first one is zero)

Returns: QString The input group name

Exceptions

IException::Programmer - "Keyword [InputPosition] cannot have a comma [,] in the value."

Definition at line 301 of file PvlTranslationTable.cpp.

References _FILEINFO_, Isis::PvlContainer::begin(), Isis::PvlContainer::end(), Isis::PvlContainer::findKeyword(), and Isis::PvlKeyword::size().

Referenced by Isis::PvlToXmlTranslationManager::doTranslation(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlToXmlTranslationManager::InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::Translate(), and Isis::PvlToPvlTranslationManager::Translate().

◆ InputKeywordName()

QString Isis::PvlTranslationTable::InputKeywordName ( const QString translationGroupName ) const

virtualinherited

Returns the input keyword name from the translation table corresponding to the output name argument.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: QString The input keyword name

Exceptions

IException::Programmer

Definition at line 376 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Isis::PvlToXmlTranslationManager::doTranslation(), Isis::PvlToXmlTranslationManager::InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::Translate(), and Isis::PvlToPvlTranslationManager::Translate().

◆ IsAuto()

bool Isis::PvlTranslationTable::IsAuto ( const QString translationGroupName )

protectedinherited

Determines whether the given group should be automatically translated.

This method returns true if the translation group contains a PvlKeyword with the name "Auto". Note: no value is assigned to this keyword.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: bool Indicates whether the given group has an Auto keyword.

Definition at line 448 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Isis::LabelTranslationManager::Auto(), Isis::PvlToXmlTranslationManager::Auto(), and Isis::PvlToPvlTranslationManager::Auto().

◆ IsOptional()

bool Isis::PvlTranslationTable::IsOptional ( const QString translationGroupName )

protectedinherited

Determines whether the translation group is optional.

This method returns true if the translation group contains a PvlKeyword with the name "Optional". Note: no value is assigned to this keyword.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: bool Indicates whether the given group has an Optional keyword.

Definition at line 473 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Isis::LabelTranslationManager::Auto(), Isis::PvlToXmlTranslationManager::Auto(), and Isis::PvlToPvlTranslationManager::Auto().

◆ OutputName()

QString Isis::PvlTranslationTable::OutputName ( const QString translationGroupName )

protectedinherited

Retrieves a string containing the value of the OutputName keyword for the translation group with the given name.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: QString The value of the OutputName keyword from the given translation group.

Definition at line 527 of file PvlTranslationTable.cpp.

References Isis::PvlContainer::hasKeyword().

Referenced by Isis::PvlToXmlTranslationManager::doTranslation(), and Isis::PvlToPvlTranslationManager::DoTranslation().

◆ OutputPosition()

PvlKeyword Isis::PvlTranslationTable::OutputPosition ( const QString translationGroupName )

protectedinherited

Retrieves the OutputPosition PvlKeyword for the translation group with the given name.

Parameters

translationGroupName The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.

Returns: PvlKeyword The OutputPosition keyword from the given translation group.

Exceptions

IException::Programmer - "Unable to find translation keyword [OutputPostion] in translation group in file."

Definition at line 499 of file PvlTranslationTable.cpp.

References _FILEINFO_, and Isis::PvlContainer::hasKeyword().

Referenced by Isis::LabelTranslationManager::CreateContainer(), and Isis::PvlToXmlTranslationManager::createParentElements().

◆ parseFile()

void Isis::XmlToPvlTranslationManager::parseFile ( const FileName & xmlFileName )

protected

Opens, parses, and internalizes an Xml label file.

Parameters

xmlFileName The Xml label file.

Exceptions

IException::Unknown	"Could not open label file."
IException::Unknown	"XML read/parse error in file."

Definition at line 479 of file XmlToPvlTranslationManager.cpp.

References _FILEINFO_, Isis::FileName::expanded(), m_xmlLabel, Isis::toString(), and Isis::IException::Unknown.

Referenced by Auto(), SetLabel(), and XmlToPvlTranslationManager().

◆ parseSpecification()

QStringList Isis::LabelTranslationManager::parseSpecification ( QString specification ) const

virtualinherited

Parses and validates a dependency specification.

Parameters

specification The dependency specification string.

Returns

QStringList The dependency split into 3 components

the type (att or tag)
the name of what to check
the value to check for

Exceptions

IException::Programmer	"Malformed dependency specification."
IException::Programmer	"Specification does not have two components separated by [@], the type of dependency and the name-value pair.
IException::Programmer	"Dependency type specification is invalid. Valid types are [att] and [tag]"
IException::Programmer	"Name-value specification does not have two components separated by [\|]."

Definition at line 187 of file LabelTranslationManager.cpp.

References _FILEINFO_, and Isis::IException::Programmer.

Referenced by Isis::PvlToXmlTranslationManager::addAttributes(), Isis::PvlToXmlTranslationManager::addSiblings(), checkDependencies(), Isis::PvlToXmlTranslationManager::createParentElements(), and Isis::PvlToXmlTranslationManager::doTranslation().

◆ SetLabel()

void Isis::XmlToPvlTranslationManager::SetLabel ( FileName & inputLabel )

Reads an Xml label file and internalizes it for translation.

Parameters

inputLabel The input label file

Definition at line 122 of file XmlToPvlTranslationManager.cpp.

References parseFile().

◆ Translate() [1/2]

QString Isis::PvlTranslationTable::Translate	(	const QString	translationGroupName,
		const QString	inputKeyValue = `""`
	)		const

inherited

Translates a single output value from the given translation group name and input value.

Parameters

translationGroupName	The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.
inputKeyValue	The value to be translated, from the input keyword.

Returns: QString The translated value, for the output keyword.

Exceptions

IException::Programmer	- "No value or default value to translate for translation group."
IException::Programmer	- "Unable to find translation value in file."

Definition at line 232 of file PvlTranslationTable.cpp.

References _FILEINFO_, Isis::PvlContainer::begin(), Isis::PvlContainer::end(), Isis::PvlContainer::fileName(), Isis::PvlContainer::findKeyword(), and Isis::PvlContainer::hasKeyword().

Referenced by Isis::PvlToXmlTranslationManager::doTranslation(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlToXmlTranslationManager::Translate(), Isis::PvlToPvlTranslationManager::Translate(), and Translate().

◆ Translate() [2/2]

QString Isis::XmlToPvlTranslationManager::Translate	(	QString	translationGroupName,
		int	index = `0`
	)

virtual

Returns a translated value.

The translation group name is used to find the input group, keyword, default and tranlations in the translation table. If the keyword does not exist in the input label, the input default if available will be used as the input value. This input value is then used to search all of the translations. If a match is found the translated value is returned.

Parameters

translationGroupName	The name of the PVL translation group used to identify the input/output keywords to be translated. Often, this is the same as the output keyword name.
index	The index into the input keyword array. Defaults to 0

Returns: QString The translated output value to be placed in the ISIS3 cube label.

Exceptions

IException::Unknown	"Failed to translate output value."
IException::Unknown	"Cannot translate value. Xml files can only store a single value in each element."
IException::Unknown	"Unable to retrieve translation group from translation table."
IException::Unknown	"Unable to retrieve [InputPosition] keyword from translation group."
IException::Unknown	"Unable to retrieve [InputKey] keyword from translation group."
IException::Unknown	"Failed traversing input position. Element does not have the named child element."
IException::Unknown	"Could not find an input value or default value."
IException::Unknown	"Input element does not have the named attribute."

Implements Isis::LabelTranslationManager.

Definition at line 178 of file XmlToPvlTranslationManager.cpp.

References _FILEINFO_, Isis::PvlContainer::begin(), checkDependencies(), Isis::PvlContainer::end(), Isis::PvlObject::findGroup(), Isis::PvlContainer::findKeyword(), Isis::PvlTranslationTable::hasInputDefault(), Isis::PvlContainer::hasKeyword(), Isis::PvlTranslationTable::InputDefault(), m_xmlLabel, Isis::PvlKeyword::name(), Isis::PvlKeyword::size(), Isis::toString(), Isis::PvlTranslationTable::Translate(), Isis::PvlTranslationTable::TranslationTable(), and Isis::IException::Unknown.

◆ TranslationTable() [1/2]

Pvl & Isis::PvlTranslationTable::TranslationTable ( )

protectedinherited

Protected accessor for pvl translation table passed into class.

This method returns a reference to the translation table member.

Returns: Pvl The translation table as a PVL object.

Definition at line 78 of file PvlTranslationTable.cpp.

Referenced by Isis::LabelTranslationManager::Auto(), Isis::PvlToXmlTranslationManager::Auto(), Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), and Translate().

◆ TranslationTable() [2/2]

const Pvl & Isis::PvlTranslationTable::TranslationTable ( ) const

protectedinherited

Protected accessor for const pvl translation table passed into class.

This method returns a const reference to the translation table member.

Returns: Pvl The translation table as a PVL object.

Definition at line 90 of file PvlTranslationTable.cpp.

◆ validKeywords()

vector< pair< QString, int > > Isis::XmlToPvlTranslationManager::validKeywords ( ) const

protectedvirtual

Returns a vector of valid keyword names and their sizes.

A size of -1 indicates that the keyword can be any size.

Returns: vector<pair<QString,int>> A vector of valid keyword names and their sizes.

Reimplemented from Isis::PvlTranslationTable.

Definition at line 133 of file XmlToPvlTranslationManager.cpp.

References Isis::PvlTranslationTable::validKeywords().

Member Data Documentation

◆ m_xmlLabel

QDomDocument Isis::XmlToPvlTranslationManager::m_xmlLabel

private

The contents of the xml label.

Definition at line 160 of file XmlToPvlTranslationManager.h.

Referenced by parseFile(), and Translate().

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

src/base/objs/XmlToPvlTranslationManager/XmlToPvlTranslationManager.h
src/base/objs/XmlToPvlTranslationManager/XmlToPvlTranslationManager.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XmlToPvlTranslationManager() [1/4]

◆ XmlToPvlTranslationManager() [2/4]

◆ XmlToPvlTranslationManager() [3/4]

◆ XmlToPvlTranslationManager() [4/4]

◆ ~XmlToPvlTranslationManager()

Member Function Documentation

◆ AddTable() [1/2]

◆ AddTable() [2/2]

◆ Auto() [1/3]

◆ Auto() [2/3]

◆ Auto() [3/3]

◆ checkDependencies()

◆ CreateContainer()

◆ DoTranslation()

◆ findTranslationGroup()

◆ hasInputDefault()

◆ InputDefault()

◆ InputGroup()

◆ InputKeywordName()

◆ IsAuto()

◆ IsOptional()

◆ OutputName()

◆ OutputPosition()

◆ parseFile()

◆ parseSpecification()

◆ SetLabel()

◆ Translate() [1/2]

◆ Translate() [2/2]

◆ TranslationTable() [1/2]

◆ TranslationTable() [2/2]

◆ validKeywords()

Member Data Documentation

◆ m_xmlLabel