DOP_Auto Class Reference

#include <DOP_Auto.h>

Inheritance diagram for DOP_Auto:

List of all members.

Public Member Functions

DOP_Auto (OP_Network *net, const char *name, OP_Operator *entry)

virtual ~DOP_Auto ()

virtual const char * inputLabel (unsigned idx) const

REturn text describing a particular input.

virtual float getVariableValue (int index, int thread)

Handle the evaluation of standard local variables.

virtual void getVariableString (int index, UT_String &str, int thread)

Handle the evaluation of standards string local variables.

virtual void getNodeSpecificInfoText (OP_Context &context, int verbose, UT_WorkBuffer &text)

Get the MMB info text for this node.

Static Public Member Functions

static OP_Node * myConstructor (OP_Network *net, const char *name, OP_Operator *entry)

Static Public Attributes

static PRM_Template theCommonTemplates []

static CH_LocalVariable theCommonVariables []

Protected Member Functions

virtual void processObjectsSubclass (fpreal time, int foroutputidx, const SIM_ObjectArray &objects, DOP_Engine &engine)

This default implementation does not affect incoming objects.

virtual void applyOutputDataSubclass (fpreal time, int outputidx, SIM_RootData &rootdata, const char *parentdataname, DOP_Engine &engine, UT_StringArray *datanames)

virtual void preNetworkProcessingSubclass (DOP_Engine &engine)

virtual void getInputInfoSubclass (int inputidx, DOP_InOutInfo &info)

This default implementation specifies the input accepts objects.

virtual void getOutputInfoSubclass (int outputidx, DOP_InOutInfo &info)

This default implementation specifies the output sends out objects.

virtual PRM_Template * getCommonTemplates () const

virtual int getFirstSubdataInput () const

virtual bool getHasInputObjects () const

virtual int SHAREDATA ()

virtual int UNIQUEDATANAME ()

virtual void DATANAME (UT_String &str, fpreal t)

void GROUP (UT_String &str, fpreal t)

const SIM_Data * getShareData (const SIM_Engine &engine, const char *lcddatatype)

void setShareData (const SIM_RootData &rootdata, const char *dataname)

void attachInputSubData (SIM_RootData &rootdata, const char *dataname, DOP_Engine &engine, float time)

void doApplyOutputData (fpreal time, int outputidx, SIM_RootData &rootdata, const char *parentdataname, DOP_Engine &engine, UT_StringArray *datanames, bool active)

virtual void doApplyOutputDataSubclass (fpreal time, int outputidx, SIM_RootData &rootdata, const char *parentdataname, DOP_Engine &engine, UT_StringArray *datanames, bool active)

void removeData (SIM_RootData &rootdata, const UT_String &dataname)

Detailed Description

Definition at line 26 of file DOP_Auto.h.

Constructor & Destructor Documentation

DOP_Auto::DOP_Auto	(	OP_Network *	net,
		const char *	name,
		OP_Operator *	entry
	)

virtual DOP_Auto::~DOP_Auto ( ) [virtual]

Member Function Documentation

virtual void DOP_Auto::applyOutputDataSubclass	(	fpreal	time,
		int	outputidx,
		SIM_RootData &	rootdata,
		const char *	parentdataname,
		DOP_Engine &	engine,
		UT_StringArray *	datanames
	)			`[protected, virtual]`

This function just makes sure we are active and that the object being processed is part of our group, and calls doApplyOutputData to do all the work of actually attaching the data.

Reimplemented from DOP_Node.

void DOP_Auto::attachInputSubData	(	SIM_RootData &	rootdata,
		const char *	dataname,
		DOP_Engine &	engine,
		float	time
	)			`[protected]`

virtual void DOP_Auto::DATANAME	(	UT_String &	str,
		fpreal	t
	)			`[protected, virtual]`

Reimplemented in DOP_AutoSolver.

void DOP_Auto::doApplyOutputData	(	fpreal	time,
		int	outputidx,
		SIM_RootData &	rootdata,
		const char *	parentdataname,
		DOP_Engine &	engine,
		UT_StringArray *	datanames,
		bool	active
	)			`[protected]`

This function actually does all the work for applyOutputDataSubclass. This extra level of indirection allows efficient impementation of the processObjectsSubclass method. This function calls doApplyOutputDataSubclass().

virtual void DOP_Auto::doApplyOutputDataSubclass	(	fpreal	time,
		int	outputidx,
		SIM_RootData &	rootdata,
		const char *	parentdataname,
		DOP_Engine &	engine,
		UT_StringArray *	datanames,
		bool	active
	)			`[protected, virtual]`

Implements the doApplyOutputData functionality. Making this function virtual allows it to be overridden (by DOP_FileData, for example).

Reimplemented in DOP_SolverPython.

virtual PRM_Template* DOP_Auto::getCommonTemplates ( ) const [protected, virtual]

Reimplemented in DOP_AutoRelType, and DOP_AutoSolver.

virtual int DOP_Auto::getFirstSubdataInput ( ) const [protected, virtual]

virtual bool DOP_Auto::getHasInputObjects ( ) const [protected, virtual]

virtual void DOP_Auto::getInputInfoSubclass	(	int	inputidx,
		DOP_InOutInfo &	info
	)			`[protected, virtual]`

This default implementation specifies the input accepts objects.

Reimplemented from DOP_Node.

virtual void DOP_Auto::getNodeSpecificInfoText	(	OP_Context &	context,
		int	verbose,
		UT_WorkBuffer &	text
	)			`[virtual]`

Get the MMB info text for this node.

Reimplemented from DOP_Node.

virtual void DOP_Auto::getOutputInfoSubclass	(	int	outputidx,
		DOP_InOutInfo &	info
	)			`[protected, virtual]`

This default implementation specifies the output sends out objects.

Reimplemented from DOP_Node.

Reimplemented in DOP_AutoRelType.

const SIM_Data* DOP_Auto::getShareData	(	const SIM_Engine &	engine,
		const char *	lcddatatype
	)			`[protected]`

virtual void DOP_Auto::getVariableString	(	int	index,
		UT_String &	value,
		int	thread
	)			`[virtual]`

Handle the evaluation of standards string local variables.

Reimplemented from DOP_Node.

virtual float DOP_Auto::getVariableValue	(	int	index,
		int	thread
	)			`[virtual]`

Handle the evaluation of standard local variables.

Reimplemented from DOP_Node.

void DOP_Auto::GROUP	(	UT_String &	str,
		fpreal	t
	)			`[protected]`

virtual const char* DOP_Auto::inputLabel ( unsigned idx ) const [virtual]

REturn text describing a particular input.

Reimplemented from DOP_Node.

static OP_Node* DOP_Auto::myConstructor	(	OP_Network *	net,
		const char *	name,
		OP_Operator *	entry
	)			`[static]`

Reimplemented in DOP_AutoRelType, DOP_AutoSolver, and DOP_SolverPython.

virtual void DOP_Auto::preNetworkProcessingSubclass ( DOP_Engine & engine ) [protected, virtual]

This function gets called on all nodes before a timestep starts. The default implementation does nothing.

Reimplemented from DOP_Node.

virtual void DOP_Auto::processObjectsSubclass	(	fpreal	time,
		int	foroutputidx,
		const SIM_ObjectArray &	objects,
		DOP_Engine &	engine
	)			`[protected, virtual]`

This default implementation does not affect incoming objects.

Reimplemented from DOP_Node.

Reimplemented in DOP_AutoRelType, and DOP_AutoSolver.

void DOP_Auto::removeData	(	SIM_RootData &	rootdata,
		const UT_String &	dataname
	)			`[protected]`

void DOP_Auto::setShareData	(	const SIM_RootData &	rootdata,
		const char *	dataname
	)			`[protected]`

virtual int DOP_Auto::SHAREDATA ( ) [protected, virtual]

Reimplemented in DOP_AutoSolver.

virtual int DOP_Auto::UNIQUEDATANAME ( ) [protected, virtual]

Reimplemented in DOP_AutoRelType, and DOP_AutoSolver.

Member Data Documentation

PRM_Template DOP_Auto::theCommonTemplates[] [static]

Reimplemented in DOP_AutoRelType, and DOP_AutoSolver.

Definition at line 45 of file DOP_Auto.h.

CH_LocalVariable DOP_Auto::theCommonVariables[] [static]

Definition at line 46 of file DOP_Auto.h.

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

DOP/DOP_Auto.h


Public Member Functions
	DOP_Auto (OP_Network net, const char name, OP_Operator *entry)
virtual	~DOP_Auto ()
virtual const char *	inputLabel (unsigned idx) const
	REturn text describing a particular input.
virtual float	getVariableValue (int index, int thread)
	Handle the evaluation of standard local variables.
virtual void	getVariableString (int index, UT_String &str, int thread)
	Handle the evaluation of standards string local variables.
virtual void	getNodeSpecificInfoText (OP_Context &context, int verbose, UT_WorkBuffer &text)
	Get the MMB info text for this node.
Static Public Member Functions
static OP_Node *	myConstructor (OP_Network net, const char name, OP_Operator *entry)
Static Public Attributes
static PRM_Template	theCommonTemplates []
static CH_LocalVariable	theCommonVariables []
Protected Member Functions
virtual void	processObjectsSubclass (fpreal time, int foroutputidx, const SIM_ObjectArray &objects, DOP_Engine &engine)
	This default implementation does not affect incoming objects.
virtual void	applyOutputDataSubclass (fpreal time, int outputidx, SIM_RootData &rootdata, const char parentdataname, DOP_Engine &engine, UT_StringArray datanames)
virtual void	preNetworkProcessingSubclass (DOP_Engine &engine)
virtual void	getInputInfoSubclass (int inputidx, DOP_InOutInfo &info)
	This default implementation specifies the input accepts objects.
virtual void	getOutputInfoSubclass (int outputidx, DOP_InOutInfo &info)
	This default implementation specifies the output sends out objects.
virtual PRM_Template *	getCommonTemplates () const
virtual int	getFirstSubdataInput () const
virtual bool	getHasInputObjects () const
virtual int	SHAREDATA ()
virtual int	UNIQUEDATANAME ()
virtual void	DATANAME (UT_String &str, fpreal t)
void	GROUP (UT_String &str, fpreal t)
const SIM_Data *	getShareData (const SIM_Engine &engine, const char *lcddatatype)
void	setShareData (const SIM_RootData &rootdata, const char *dataname)
void	attachInputSubData (SIM_RootData &rootdata, const char *dataname, DOP_Engine &engine, float time)
void	doApplyOutputData (fpreal time, int outputidx, SIM_RootData &rootdata, const char parentdataname, DOP_Engine &engine, UT_StringArray datanames, bool active)
virtual void	doApplyOutputDataSubclass (fpreal time, int outputidx, SIM_RootData &rootdata, const char parentdataname, DOP_Engine &engine, UT_StringArray datanames, bool active)
void	removeData (SIM_RootData &rootdata, const UT_String &dataname)