SmartEngine  1.6.0
Public Member Functions | List of all members
SmartEngine::IStandardGraphModel Class Referenceabstract

Interface to the standard model that interacts with a graph. This can be used to extend the standard model with custom code by encapsulating this object More...

#include <GraphModel.h>

Inheritance diagram for SmartEngine::IStandardGraphModel:
SmartEngine::IGraphModel SmartEngine::IObject

Public Member Functions

virtual ObjectPtr< IGraphGetGraph () const =0
 Returns the graph associated with this model. More...
 
virtual MatrixIndex GetExpectedRowCount (int controllerId, const char *outputName) const =0
 Returns the number of rows we expect to see for the specified controller and output. Returns -1 on error. More...
 
- Public Member Functions inherited from SmartEngine::IGraphModel
virtual void ClearData ()=0
 Clear all data from the last execution, including requested output. More...
 
virtual void AddData (const char *nodeName, IMatrix *data)=0
 Add one or more rows of data to the specified node. More...
 
virtual void RequestOutput (int controllerId, const char *nodeName, MatrixIndex expectedRowCount)=0
 Execute() should produce output for this node. More...
 
virtual void Execute ()=0
 Execute the model and save the results locally. More...
 
virtual void RetrieveOutput (int controllerId, IGraphModelOutput *modelOut)=0
 Dump all output for the specified controller from the last execution into modelOut. More...
 
virtual void Reset ()=0
 Called upon request from the user. Reset any internal state. More...
 
- Public Member Functions inherited from SmartEngine::IObject
virtual ObjectId GetId () const =0
 Returns the ID of this object. More...
 
virtual void AddRef () const =0
 Increments the internal reference count on this object. It is not common to use this method directly. More...
 
virtual void Release () const =0
 Decrements the internal reference count on this object. It is not common to use this method directly. More...
 
virtual int GetRefCount () const =0
 Returns the number of references to this object. More...
 
virtual void * QueryInterface (ObjectClassId id)=0
 Queries the object for an interface and returns a pointer to that interface if found. More...
 
void operator= (IObject const &x)=delete
 

Additional Inherited Members

- Public Attributes inherited from SmartEngine::IObject
 private
 
 __pad0__: IObject() {} IObject(IObject const&) = delete
 

Detailed Description

Interface to the standard model that interacts with a graph. This can be used to extend the standard model with custom code by encapsulating this object

Member Function Documentation

◆ GetExpectedRowCount()

virtual MatrixIndex SmartEngine::IStandardGraphModel::GetExpectedRowCount ( int  controllerId,
const char *  outputName 
) const
pure virtual

Returns the number of rows we expect to see for the specified controller and output. Returns -1 on error.

◆ GetGraph()

virtual ObjectPtr<IGraph> SmartEngine::IStandardGraphModel::GetGraph ( ) const
pure virtual

Returns the graph associated with this model.