FlowEngine::NamedObjectInterface Class Reference

Interface for all FlowEngine objects with an editable name. More...

#include <NamedObjectInterface.h>

Inheritance diagram for FlowEngine::NamedObjectInterface:

Public Member Functions
virtual FLE_DLL	~NamedObjectInterface ()=default
	Default virtual destructor.
virtual FLE_DLL Size	getNameLength () const =0
virtual FLE_DLL Result	getName (StringBuffer outName) const =0
virtual FLE_DLL Result	setName (ConstStringBuffer name)=0

Detailed Description

Interface for all FlowEngine objects with an editable name.

Constructor & Destructor Documentation

~NamedObjectInterface()

virtual FLE_DLL FlowEngine::NamedObjectInterface::~NamedObjectInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getName()

virtual FLE_DLL Result FlowEngine::NamedObjectInterface::getName ( StringBuffer  outName ) const

pure virtual

Returns

the length of the name of this entity.

Parameters

outName

a buffer that receives the name of the entity. Must be at least getNameLength() long.

Returns

One of the following result codes:

• Result::Success – if the buffer was successfully filled with the entity name.
• Result::InvalidArgument – if outName is not a valid string buffer.
• Result::BufferTooSmall – if outName is not big enough.

getNameLength()

virtual FLE_DLL Size FlowEngine::NamedObjectInterface::getNameLength ( ) const

pure virtual

Returns

the length of the name of this entity.

setName()

virtual FLE_DLL Result FlowEngine::NamedObjectInterface::setName ( ConstStringBuffer  name )

pure virtual

Set the name of this entity.

Parameters

name	a constant string buffer containing the name of the entity

Returns

One of the following result codes:

• Result::Success – if the entity name was successfully changed.
• Result::InvalidArgument – if name is not a valid string buffer.