Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES > Interface Template Reference

The ResourceTarget class. More...

#include "murl_graph_resource_target.h"

Inheritance diagram for Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >:

Public Member Functions

 ResourceTarget ()
 The constructor.
 
 ResourceTarget (ObjectType *object)
 Constructor taking a single (optional) object. More...
 
Bool DeserializeResourceId (IDeserializeAttributeTracker *tracker)
 Deserialize the single target resource ID from a given tracker. More...
 
const StringGetResourceId () const
 Get the single resource ID. More...
 
const ObjectType * GetResource () const
 Get the single resource object. More...
 

Detailed Description

template<class ObjectType, UInt32 MIN_NUMBER_OF_RESOURCES>
interface Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >

The ResourceTarget class.

This class implements an IGenericResourceTarget that can reference at most one resource object. The MIN_NUMBER_OF_RESOURCES template parameter represents the minimum number of referenced resources that must be present for the Init() method to succeed. May be either 0 or 1.

Constructor & Destructor Documentation

◆ ResourceTarget()

template<class ObjectType , UInt32 MIN_NUMBER_OF_RESOURCES>
Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >::ResourceTarget ( ObjectType *  object)
inline

Constructor taking a single (optional) object.

Parameters
objectThe object or null.

Member Function Documentation

◆ DeserializeResourceId()

template<class ObjectType , UInt32 MIN_NUMBER_OF_RESOURCES>
Bool Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >::DeserializeResourceId ( IDeserializeAttributeTracker tracker)
inline

Deserialize the single target resource ID from a given tracker.

Parameters
trackerThe tracker to deserialize.
Returns
true if successful.

References Murl::Graph::IDeserializeAttributeTracker::GetAttributeValue(), and Murl::Graph::IDeserializeAttributeTracker::MakeResourceIdAbsolute().

◆ GetResourceId()

template<class ObjectType , UInt32 MIN_NUMBER_OF_RESOURCES>
const String& Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >::GetResourceId ( ) const
inline

Get the single resource ID.

Returns
The resource ID, or an empty string if no resource is referenced.

◆ GetResource()

template<class ObjectType , UInt32 MIN_NUMBER_OF_RESOURCES>
const ObjectType* Murl::Graph::ResourceTarget< ObjectType, MIN_NUMBER_OF_RESOURCES >::GetResource ( ) const
inline

Get the single resource object.

Returns
The resource object, or null if none is referenced.

The documentation for this interface was generated from the following file:
  • murl_graph_resource_target.h


Copyright © 2011-2024 Spraylight GmbH.