The IScript resource object interface. More...

#include "murl_resource_i_script.h"

Inheritance diagram for Murl::Resource::IScript:

Classes

struct  Iff
 IFF file specific structs. More...
 

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
 
virtual Logic::IProcessorPtr CreateIProcessor (const Logic::IState *logicState, const String &info) const =0
 Create a logic processor object from the script data. More...
 
virtual Logic::IAppGraphPtr CreateIAppGraph (const String &info) const =0
 Create a logic app graph object from the script data. More...
 
virtual const ConstDataGetData () const =0
 Get a data object containing the script data. More...
 
virtual Bool ReleaseData () const =0
 Release the previously obtained data. More...
 

Detailed Description

The IScript resource object interface.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IScript::GetObjectInterface ( )
pure virtual

Get the mutable Resource::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IScript::GetObjectInterface ( ) const
pure virtual

Get the constant Resource::IObject interface.

Returns
The IObject interface.

◆ CreateIProcessor()

virtual Logic::IProcessorPtr Murl::Resource::IScript::CreateIProcessor ( const Logic::IState logicState,
const String info 
) const
pure virtual

Create a logic processor object from the script data.

Parameters
logicStateThe logic state object.
infoA string containing additional information passed to the script, e.g. the replication number when created from resource script instance.
Returns
The logic processor object or null if creation failed.

◆ CreateIAppGraph()

virtual Logic::IAppGraphPtr Murl::Resource::IScript::CreateIAppGraph ( const String info) const
pure virtual

Create a logic app graph object from the script data.

Parameters
infoA string containing additional information passed to the script, e.g. the replication number when created from resource script instance.
Returns
The logic app graph object or null if creation failed.

◆ GetData()

virtual const ConstData& Murl::Resource::IScript::GetData ( ) const
pure virtual

Get a data object containing the script data.

Calling this method returns a constant data object containing the script data, performing decryption if necessary. If decryption fails, an empty data object is returned. It is necessary to make a corresponding call to ReleaseData() for every GetData() invocation.

Returns
A constant data object containing the script contents.

◆ ReleaseData()

virtual Bool Murl::Resource::IScript::ReleaseData ( ) const
pure virtual

Release the previously obtained data.

Returns
true if successful.

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


Copyright © 2011-2018 Spraylight GmbH.