Arp::Io::Commons::Configuration::TicLinksConfiguration Class Reference

This class is used to read the links.xml file, which is the entry point of a Tic configuration. More...

#include <TicLinksConfiguration.hpp>

Public Types
using	Arcs = std::vector< TicArc >

Public Member Functions
	TicLinksConfiguration (const TicLinksConfiguration &arg)=delete
	TicLinksConfiguration (TicLinksConfiguration &&arg) noexcept
	Default move constructor.
TicLinksConfiguration &	operator= (const TicLinksConfiguration &arg)=delete
TicLinksConfiguration &	operator= (TicLinksConfiguration &&arg) noexcept
	Default move-assignment operator.
	~TicLinksConfiguration (void)
	Default destructor.
	TicLinksConfiguration (void)
	Default constructor.
const Arcs &	GetArcs (void) const noexcept
	Gets a list of TicArc specifing the hierarchy of Tic documents. More...
void	Load (const String &filename)
	Loads a Tic configuration file. More...
Impl &	GetImpl (void)
	For internal use only.
const Impl &	GetImpl (void) const

Detailed Description

This class is used to read the links.xml file, which is the entry point of a Tic configuration.

The links file just contains references to a couple of Tic documents, providing a complete Tic configuration.

Member Function Documentation

GetArcs()

const TicLinksConfiguration::Arcs & Arp::Io::Commons::Configuration::TicLinksConfiguration::GetArcs ( void  ) const

noexcept

Gets a list of TicArc specifing the hierarchy of Tic documents.

Returns

A list of TicArc.

Load()

void Arp::Io::Commons::Configuration::TicLinksConfiguration::Load

(

const String &

filename

)

Loads a Tic configuration file.

Parameters

filename

The filename of the file to load.

---

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

• Arp/Io/Commons/Configuration/TicLinksConfiguration.hpp
• Arp/Io/Commons/Configuration/TicLinksConfiguration.cpp