AzFramework::Dependency< N > Class Template Reference

#include <Dependency.h>

Classes
class	Bound

Public Member Functions
	Dependency (const Dependency &dep)
const AZ::Uuid &	GetID () const
void	SetID (const AZ::Uuid &id)
const AZStd::vector< Bound > &	GetBounds () const
bool	IsFullfilledBy (const Specifier< N > &spec) const
AZ::Outcome< void, AZStd::string >	ParseVersions (const AZStd::vector< AZStd::string > &deps)

Public Attributes
AZ::Uuid	m_id = AZ::Uuid::CreateNull()
AZStd::vector< Bound >	m_bounds

Detailed Description

template<size_t N>
class AzFramework::Dependency< N >

Defines a Gem's dependency upon another Gem.

Member Function Documentation

GetBounds()

template<size_t N>

const AZStd::vector< typename Dependency< N >::Bound > & AzFramework::Dependency< N >::GetBounds

Gets the bounds that the dependence's version must fulfill.

Returns

The list of bounds.

GetID()

template<size_t N>

const AZ::Uuid & AzFramework::Dependency< N >::GetID

Gets the ID of the Gem depended on.

Returns

The ID of the Gem depended on.

IsFullfilledBy()

template<size_t N>

bool AzFramework::Dependency< N >::IsFullfilledBy

(

const Specifier< N > &

spec

)

const

Checks if a specifier matches a dependency.

Checks that the specifier's ID is the one depended on, and that the version matches the bounds (which can be retrieved by GetBounds()).

\params[in] spec The specifier to test.

Returns

Whether or not the Specifier<N> fits the dependency.

ParseVersions()

template<size_t N>

AZ::Outcome< void, AZStd::string > AzFramework::Dependency< N >::ParseVersions

(

const AZStd::vector< AZStd::string > &

deps

)

Parses version bounds from a list of strings.

Each string should fit the pattern [OPERATOR][VERSION], where [OPERATOR] is >, >=, <, <=, ==, or ~>, and [VERSION] is a valid version string, parsable by Gems::Version<N>.

\params[in] deps The list of bound strings to parse.

Returns

True on success, false on failure.

SetID()

template<size_t N>

void AzFramework::Dependency< N >::SetID

(

const AZ::Uuid &

id

)

Set the ID of the Gem depended on.

\params[in] id The ID of the dependency

---

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

• Code/Framework/AzFramework/AzFramework/Dependency/Dependency.h
• Code/Framework/AzFramework/AzFramework/Dependency/Dependency.inl