DDD_ConnectionEndpoint Class Reference

The DDD_ConnectionEndpoint class. Endpoints are used as inputs and outputs to connections. More...

#include <DDD_ConnectionEndpoint.h>

Public Member Functions
	DDD_ConnectionEndpoint (DDD_AttributeBase *attribute, std::string converterPoint)
	~DDD_ConnectionEndpoint ()
bool	Valid ()
std::string	AttributeName ()
std::string	AssetName ()
std::string	ConverterPointName ()
void	SetConverterPointName (const std::string &converterPoint)
void	SetAttribute (DDD_AttributeBase *attribute)
DDD_AttributeBase *	GetAttribute ()
void	Invalidate ()
bool	DisconnectAsset (DDD_AttributeContainer *attContainer)
void	NotifyAssetNameChange (const std::string &oldname, const std::string &newname)

Detailed Description

The DDD_ConnectionEndpoint class. Endpoints are used as inputs and outputs to connections.

Constructor & Destructor Documentation

DDD_ConnectionEndpoint	(	DDD_AttributeBase *	attribute,
		std::string	converterPoint
	)

Constructor.

Parameters

attribute	A pointer to the Attribute that will be connected
converterPoint	The name of the converter "pin" that this will be connected to

~DDD_ConnectionEndpoint

(

)

Destructor

Member Function Documentation

std::string AssetName

(

)

Returns

Returns the name of the asset associated with this endpoint

std::string AttributeName

(

)

Returns

Returns the name of the attribute associated with this endpoint

std::string ConverterPointName

(

)

Returns

Returns the name of the converter point associated with this endpoint

bool DisconnectAsset

(

DDD_AttributeContainer *

attContainer

)

Called by the framework when an asset is deleted. If the attribute container (asset) specified matches the container for this endpoint, then the endpoint is invalidated

Parameters

attContainer

The asset that is being deleted

Returns

True if this endpoint was invalidated by this call

DDD_AttributeBase* GetAttribute

(

)

Returns

Returns a pointer to the attribute this endpoint is connected to

void Invalidate

(

)

Invalidates this endpoint, i.e. after this call this endpoint will no longer be associated with an instance of an attribute, it will be disconnected.

void NotifyAssetNameChange	(	const std::string &	oldname,
		const std::string &	newname
	)

Called by the framework when an asset is renamed. If the asset specified in oldName matches the asset name associated with this endpoint, then the endpoint is updated to reference the newName

Parameters

oldname	The old name of the asset
newname	The new name of the asset

void SetAttribute

(

DDD_AttributeBase *

attribute

)

Set the attribute that this endpoint is connected to

Parameters

attribute

Pointer to the attribute to connect to

void SetConverterPointName

(

const std::string &

converterPoint

)

Set the converter point name for this endpoint \ param converterPoint The name of the converter "pin" this endpoint is connected to

bool Valid

(

)

Returns

Returns true if this endpoint is valid, i.e. if it references a valid attribute of a valid, loaded asset.

---

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

• DDD_ConnectionEndpoint.h