Isis 3 Programmer Reference
Isis::PvlToXmlTranslationManager Class Reference

Allows applications to translate simple text files. More...

#include <PvlToXmlTranslationManager.h>

Inheritance diagram for Isis::PvlToXmlTranslationManager:
Inheritance graph
Collaboration diagram for Isis::PvlToXmlTranslationManager:
Collaboration graph

Public Member Functions

 PvlToXmlTranslationManager (const QString &transFile)
 Constructs and initializes a TranslationManager object from given the Pvl translation file. More...
 
 PvlToXmlTranslationManager (Pvl &inputLabel, const QString &transFile)
 Constructs and initializes a TranslationManager object. More...
 
virtual ~PvlToXmlTranslationManager ()
 Destroys the TranslationManager object. More...
 
virtual QString Translate (QString translationGroupName, int inputIndex=0)
 Returns a translated value. More...
 
void Auto (QDomDocument &outputLabel)
 Automatically translate all the output names found in the translation table. More...
 
void Auto (Pvl &inputLabel, QDomDocument &outputLabel)
 Set the inputLabel and automatically translate all the output names found in the translation table. More...
 
virtual const PvlKeywordInputKeyword (const QString translationGroupName) const
 Uses the translation file group name to find the input label's PvlKeyword that corresponds to the InputKey value of the translation table and returns it, if found. More...
 
virtual bool InputHasKeyword (const QString translationGroupName)
 Indicates if the input keyword corresponding to the output name exists in the label. More...
 
void SetLabel (Pvl &inputLabel)
 Internalizes a Pvl formatted label for translation. 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...
 

Static Public Member Functions

static void addElement (QDomElement &parent, QString name, QString value, QString units="")
 Add a QDomElement to the given parent with the indicated value and units. More...
 
static void setElementValue (QDomElement &element, QString value, QString units="")
 Set the QDomElement's value, and units, if units != "". More...
 
static void resetElementValue (QDomElement &element, QString value, QString units="")
 Reset the QDomElement's value, and units, if units != "". More...
 

Protected Member Functions

void doTranslation (PvlGroup transGroup, QDomElement &parent)
 Translate the requested output name to output values using the input name and values or default value. More...
 
virtual const PvlContainerGetContainer (const PvlKeyword &inputGroup) const
 Return a container from the input label with the path given by the "InputPosition" keyword of the translation table. More...
 
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
 
QDomElement * createParentElements (const QString translationGroupName, QDomElement &xml)
 Read the OutputPosition for the translation group name passed and create any parent elements specified by OutputPosition to prepare for translation. More...
 
void addSiblings (PvlKeyword outputSiblings, QDomElement &parent)
 Take in outputSiblings PvlKeyword and turn each sibling into its corresponding QDomElement. More...
 
void addAttributes (PvlKeyword something, QDomElement &parent)
 Take in the outputAttributes PvlKeyword and add each attribute to the appropriate element given as an argument. 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 PvlContainerCreateContainer (const QString translationGroupName, Pvl &pvl)
 Creates all parent PVL containers for an output keyword. More...
 
PvlTranslationTable ()
 Protected accessor for pvl translation table passed into class. More...
 
const PvlTranslationTable () 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 PvlGroupfindTranslationGroup (const QString translationGroupName) const
 Searches for translation group with the given name. More...
 

Private Attributes

Pvl m_inputLabel
 A Pvl object for the input label file. More...
 

Detailed Description

Allows applications to translate simple text files.

This class allows the translation of text files which can be parsed by the Pvl class into Xml files.

Author
2017-05-24 Jeannie Backer and Ian Humphrey
History:

2017-05-24 Jeannie Backer and Ian Humphrey - Original version.

2017-05-26 Ian Humphrey & Makayla Shepherd - Added createParentElements.

2017-05-26 Makayla Shepherd & Adam Paquette - Added addSiblings and setElementValue.

2017-05-30 Makayla Shepherd - Renamed p_fLabel to m_inputLabel, and updated documentation.

2017-05-31 Adam Paquette - Added addAttributes method.

2017-05-31 Ian Humphrey & Makayla Shepherd - Fixed duplicate root xml element in output xml file.

2017-06-02 Makayla Shepherd - Made setElementValue public.

2017-10-18 Jeannie Backer & Makayla Shepherd - Added convenience methods, addElement and resetElementValue, and made setElementValue static. See #5202.

2017-10-31 Jeannie Backer - Moved creation of sibling elements in doTranslation() so that this only happens if the translation is succesful.

Definition at line 66 of file PvlToXmlTranslationManager.h.

Constructor & Destructor Documentation

◆ PvlToXmlTranslationManager() [1/2]

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

Constructs and initializes a TranslationManager object from given the 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(Pvl inputLabel) or Auto(Pvl inputLabel, Pvl outputLabel).

Parameters
transFileThe translation file to be used to tranlate keywords in the input label.

Definition at line 51 of file PvlToXmlTranslationManager.cpp.

◆ PvlToXmlTranslationManager() [2/2]

Isis::PvlToXmlTranslationManager::PvlToXmlTranslationManager ( Pvl inputLabel,
const QString &  transFile 
)

Constructs and initializes a TranslationManager object.

Parameters
inputLabelThe Pvl holding the input label.
transFileThe translation file to be used to tranlate keywords in the input label.

Definition at line 64 of file PvlToXmlTranslationManager.cpp.

References m_inputLabel.

◆ ~PvlToXmlTranslationManager()

Isis::PvlToXmlTranslationManager::~PvlToXmlTranslationManager ( )
virtual

Destroys the TranslationManager object.

Definition at line 72 of file PvlToXmlTranslationManager.cpp.

Member Function Documentation

◆ addAttributes()

void Isis::PvlToXmlTranslationManager::addAttributes ( PvlKeyword  outputAttributes,
QDomElement &  element 
)
protected

Take in the outputAttributes PvlKeyword and add each attribute to the appropriate element given as an argument.

Parameters
outputAttributesThe PvlKeyword that holds the list of siblings
elementQDomElement to be modified
Exceptions
IException::Programmer"Malformed output attribute [" + outputAttributes[i] + ]."

Definition at line 486 of file PvlToXmlTranslationManager.cpp.

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

Referenced by doTranslation().

◆ addElement()

void Isis::PvlToXmlTranslationManager::addElement ( QDomElement &  parent,
QString  name,
QString  value,
QString  units = "" 
)
static

Add a QDomElement to the given parent with the indicated value and units.

Parameters
parentThe parent QDomElement of the new element.
nameThe name of the new element.
valueThe value of the new element.
unitsA string containing the unit specification for the new element.

Definition at line 513 of file PvlToXmlTranslationManager.cpp.

References setElementValue().

◆ addSiblings()

void Isis::PvlToXmlTranslationManager::addSiblings ( PvlKeyword  outputSiblings,
QDomElement &  parent 
)
protected

Take in outputSiblings PvlKeyword and turn each sibling into its corresponding QDomElement.

Then add the QDomElement to the parent as a child.

Parameters
outputSiblingsThe PvlKeyword that holds the list of siblings
parentThe parent QDomElement
Exceptions
IException::Programmer"Malformed OutputSibling [" + outputSiblings[i] + "]"

Definition at line 453 of file PvlToXmlTranslationManager.cpp.

References _FILEINFO_, Isis::LabelTranslationManager::parseSpecification(), Isis::IException::Programmer, setElementValue(), and Isis::PvlKeyword::size().

Referenced by doTranslation().

◆ 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
transStmThe 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 Isis::XmlToPvlTranslationManager::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
transFileThe 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
outputLabelThe 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::PvlToXmlTranslationManager::Auto ( QDomDocument &  outputLabel)

◆ Auto() [3/3]

void Isis::PvlToXmlTranslationManager::Auto ( Pvl inputLabel,
QDomDocument &  outputLabel 
)

Set the inputLabel and automatically translate all the output names found in the translation table.

If a output name does not translate an error will be thrown by one of the support members. If the output name is translated, store the translated key, value pairs in the QDomDocument.

Parameters
inputLabelThe input Pvl label
outputLabelThe output QDomDocument label
See also
Auto(QDomDocument &outputLabel)

Definition at line 222 of file PvlToXmlTranslationManager.cpp.

References Auto(), and m_inputLabel.

◆ 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
translationGroupNameThe name of the output keyword. The OutputPosition keyword in the translation group for translationGroupName will be used to determine which containers are made.
pvlThe 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().

◆ createParentElements()

QDomElement * Isis::PvlToXmlTranslationManager::createParentElements ( const QString  translationGroupName,
QDomElement &  xmlRootElement 
)
protected

Read the OutputPosition for the translation group name passed and create any parent elements specified by OutputPosition to prepare for translation.

Parameters
constQString translationGroupName Name of the translation group we will grab OutputPosition from.
QDomElement&xmlRootElement The XML document root element to add to.
Returns
QDomElement * Returns a pointer to the parent element right above the element we are going to create when the caller starts the translation.

Definition at line 393 of file PvlToXmlTranslationManager.cpp.

References Isis::PvlTranslationTable::OutputPosition(), Isis::LabelTranslationManager::parseSpecification(), and Isis::PvlKeyword::size().

Referenced by Auto().

◆ 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
outputNameThe 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().

◆ doTranslation()

void Isis::PvlToXmlTranslationManager::doTranslation ( PvlGroup  transGroup,
QDomElement &  parentElement 
)
protected

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

Parameters
transGroupNameThe output name used to identify the input keyword to be translated.
parentElementThe element that is the parent of the new QDomElement, if a new element is created. If a new element is not created, then parentElement will have an attribute added to it.

Definition at line 148 of file PvlToXmlTranslationManager.cpp.

References addAttributes(), addSiblings(), Isis::PvlContainer::findKeyword(), GetContainer(), Isis::PvlContainer::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationTable::InputKeywordName(), Isis::PvlContainer::name(), Isis::PvlKeyword::name(), Isis::PvlTranslationTable::OutputName(), Isis::LabelTranslationManager::parseSpecification(), setElementValue(), Isis::PvlTranslationTable::Translate(), and Isis::PvlKeyword::unit().

Referenced by 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
translationGroupNameThe 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().

◆ GetContainer()

const PvlContainer * Isis::PvlToXmlTranslationManager::GetContainer ( const PvlKeyword inputGroup) const
protectedvirtual

Return a container from the input label with the path given by the "InputPosition" keyword of the translation table.

Parameters
inputGroupThe InputPosition keyword
Returns
PvlContainer* Pointer to the PvlContainer found

Definition at line 345 of file PvlToXmlTranslationManager.cpp.

References Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlObject::hasObject(), m_inputLabel, Isis::PvlKeyword::size(), and Isis::PvlKeyword::stringEqual().

Referenced by doTranslation(), InputHasKeyword(), InputKeyword(), and Translate().

◆ 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
translationGroupNameThe 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 Isis::XmlToPvlTranslationManager::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
translationGroupNameThe 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 Isis::XmlToPvlTranslationManager::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
translationGroupNameThe 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.
instThe 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 doTranslation(), Isis::PvlToPvlTranslationManager::DoTranslation(), InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), Translate(), and Isis::PvlToPvlTranslationManager::Translate().

◆ InputHasKeyword()

bool Isis::PvlToXmlTranslationManager::InputHasKeyword ( const QString  transGroupName)
virtual

Indicates if the input keyword corresponding to the output name exists in the label.

Parameters
transGroupNameThe output name used to identify the input keyword.
Returns
bool If the input keyword exists in the input label.

Definition at line 319 of file PvlToXmlTranslationManager.cpp.

References GetContainer(), Isis::PvlContainer::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), and Isis::PvlTranslationTable::InputKeywordName().

◆ InputKeyword()

const PvlKeyword & Isis::PvlToXmlTranslationManager::InputKeyword ( const QString  transGroupName) const
virtual

Uses the translation file group name to find the input label's PvlKeyword that corresponds to the InputKey value of the translation table and returns it, if found.

Parameters
transGroupNameThe name of the translation group for this InputKey.
Returns
PvlKeyword The input PvlKeyword for the translation group.
Exceptions
IException::Programmer

Definition at line 269 of file PvlToXmlTranslationManager.cpp.

References _FILEINFO_, Isis::PvlContainer::fileName(), Isis::PvlContainer::findKeyword(), GetContainer(), Isis::PvlContainer::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationTable::InputKeywordName(), Isis::PvlKeyword::name(), Isis::IException::Programmer, Isis::PvlKeyword::size(), and Isis::PvlTranslationTable::TranslationTable().

◆ 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
translationGroupNameThe 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 doTranslation(), InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), 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
translationGroupNameThe 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(), 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
translationGroupNameThe 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(), 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
translationGroupNameThe 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 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
translationGroupNameThe 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 createParentElements().

◆ parseSpecification()

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


Parses and validates a dependency specification.

Parameters
specificationThe dependency specification string.
Returns
QStringList The dependency split into 3 components
  1. the type (att or tag)
  2. the name of what to check
  3. 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 addAttributes(), addSiblings(), Isis::XmlToPvlTranslationManager::checkDependencies(), createParentElements(), and doTranslation().

◆ resetElementValue()

void Isis::PvlToXmlTranslationManager::resetElementValue ( QDomElement &  element,
QString  value,
QString  units = "" 
)
static

Reset the QDomElement's value, and units, if units != "".

Parameters
elementThe QDomElement whose value needs to be reset.
valueThe value to set.
unitsA string containing the unit specification.

Definition at line 551 of file PvlToXmlTranslationManager.cpp.

◆ setElementValue()

void Isis::PvlToXmlTranslationManager::setElementValue ( QDomElement &  element,
QString  value,
QString  units = "" 
)
static

Set the QDomElement's value, and units, if units != "".

Parameters
elementThe QDomElement whose value needs to be set.
valueThe value to set.
unitsA string containing the unit specification.

Definition at line 531 of file PvlToXmlTranslationManager.cpp.

Referenced by addElement(), addSiblings(), and doTranslation().

◆ SetLabel()

void Isis::PvlToXmlTranslationManager::SetLabel ( Pvl inputLabel)

Internalizes a Pvl formatted label for translation.

Parameters
inputLabelThe Pvl formatted label to be translated.

Definition at line 81 of file PvlToXmlTranslationManager.cpp.

References m_inputLabel.

◆ Translate() [1/2]

QString Isis::PvlToXmlTranslationManager::Translate ( QString  transGroupName,
int  inputIndex = 0 
)
virtual

Returns a translated value.

The output 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
transGroupNameThe output name used to identify the input keyword to be translated.
findexThe index into the input keyword array. Defaults to 0
Returns
QString The translated value.

Implements Isis::LabelTranslationManager.

Definition at line 119 of file PvlToXmlTranslationManager.cpp.

References GetContainer(), Isis::PvlContainer::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationTable::InputKeywordName(), and Isis::PvlTranslationTable::Translate().

◆ Translate() [2/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
translationGroupNameThe 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.
inputKeyValueThe 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 doTranslation(), Isis::PvlToPvlTranslationManager::DoTranslation(), Translate(), Isis::PvlToPvlTranslationManager::Translate(), and Isis::XmlToPvlTranslationManager::Translate().

◆ 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(), Auto(), Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlToPvlTranslationManager::DoTranslation(), InputKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), and Isis::XmlToPvlTranslationManager::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::PvlToXmlTranslationManager::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.
See also
PvlTranslationTable::validKeywords()

Reimplemented from Isis::PvlTranslationTable.

Definition at line 94 of file PvlToXmlTranslationManager.cpp.

References validKeywords(), and Isis::PvlTranslationTable::validKeywords().

Referenced by validKeywords().

Member Data Documentation

◆ m_inputLabel

Pvl Isis::PvlToXmlTranslationManager::m_inputLabel
private

A Pvl object for the input label file.

Definition at line 107 of file PvlToXmlTranslationManager.h.

Referenced by Auto(), GetContainer(), PvlToXmlTranslationManager(), and SetLabel().


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