GIDI::ExternalFile Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::ExternalFile:

Public Member Functions
	ExternalFile (std::string const &a_label, std::string const &a_path)
	ExternalFile (HAPI::Node const &a_node, SetupInfo &a_setupInfo, GIDI::Suite *a_parent)
	~ExternalFile ()
std::string const &	path () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
std::string	xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual Ancestry *	findInAncestry3 (std::string const &a_item)=0
virtual Ancestry const *	findInAncestry3 (std::string const &a_item) const =0
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	toXLink () const
void	printXML () const

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

This class represents the GNDS <externalFile> node.

Definition at line 3029 of file GIDI.hpp.

Constructor & Destructor Documentation

ExternalFile() [1/2]

GIDI::ExternalFile::ExternalFile	(	std::string const &	a_label,
		std::string const &	a_path )

Definition at line 22 of file GIDI_externalFile.cc.

                                                                              :
        Form( GIDI_externalFileChars, FormType::externalFile, a_label ),
        m_path( a_path ) {
 
}

Referenced by ExternalFile().

ExternalFile() [2/2]

GIDI::ExternalFile::ExternalFile	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		GIDI::Suite *	a_parent )

~ExternalFile()

GIDI::ExternalFile::~ExternalFile

(

)

Definition at line 43 of file GIDI_externalFile.cc.

                             {
 
}

Member Function Documentation

path()

std::string const & GIDI::ExternalFile::path ( ) const

inline

Definition at line 3039 of file GIDI.hpp.

{ return( m_path ); }

Referenced by toXMLList().

toXMLList()

void GIDI::ExternalFile::toXMLList ( GUPI::WriteInfo & a_writeInfo, std::string const & a_indent = "" ) const

virtual

Fills the argument a_writeInfo with the XML line that represent this.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.

Reimplemented from GUPI::Ancestry.

Definition at line 54 of file GIDI_externalFile.cc.

                                                                                          {
 
    std::string attributes;
 
    attributes  = a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
    attributes += a_writeInfo.addAttribute( GIDI_pathChars, path( ) );
 
    a_writeInfo.addNodeStarterEnder( a_indent, moniker( ), attributes );
}

---

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

• GIDI.hpp
• GIDI_externalFile.cc