This class is used to store the file information of a TicNode in a TicArc. More...

#include <TicNode.hpp>

Public Member Functions
	TicNode (const String &name, std::shared_ptr< String > directoryPathPtr)
	Constructs an TicNode instance. More...

	TicNode (const TicNode &arg)
	Default copy constructor.

	TicNode (TicNode &&arg) noexcept
	Default move constructor.

TicNode &	operator= (const TicNode &arg)
	Default copy-assignment operator.

TicNode &	operator= (TicNode &&arg) noexcept
	Default move-assignment operator.

	~TicNode (void)
	Default destructor.

String	GetName (void) const
	Gets the name of the TicNode More...

String	GetDirectoryPath (void) const
	Gets the directory path of the tic node More...

Impl &	GetImpl (void)
	For internal use only.

const Impl &	GetImpl (void) const

Friends
ARP_EXPORT friend bool	operator== (const TicNode &lhs, const TicNode &rhs)

Detailed Description

This class is used to store the file information of a TicNode in a TicArc.

The directoryPath is passed in the constructor as a shared pointer which allows to change the directory path from other pointer holders. This pointer can be used to overwrite the directory path of a tic node.

The filename of the TicNode can be retrieved by GetName().

The directory path of the tic file can be retrieved by GetDirectoryPath().

Constructor & Destructor Documentation

◆ TicNode()

Arp::Io::Commons::Configuration::TicNode::TicNode	(	const String &	name,
		std::shared_ptr< String >	directoryPathPtr
	)

explicit

Constructs an TicNode instance.

Parameters

name	Specifies the name of the TicNode
directoryPathPtr	Specifies a pointer to a string that contains the directory path of this tic node.

Member Function Documentation

◆ GetDirectoryPath()

String Arp::Io::Commons::Configuration::TicNode::GetDirectoryPath ( void ) const

Gets the directory path of the tic node

Returns: The directory path of the TicNode

◆ GetName()

String Arp::Io::Commons::Configuration::TicNode::GetName ( void ) const

Gets the name of the TicNode

Returns: The name of the tic node

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

Arp/Io/Commons/Configuration/TicNode.hpp
Arp/Io/Commons/Configuration/TicNode.cpp