Method Class Reference

Wraps the inputs, outputs, and code for a method (i.e., initialize, run, etc) within a scripted component. More...

#include <Method.h>

Collaboration diagram for Method:

Public Member Functions
	Method (DefinedBehavior *definedBehavior, MethodInfo *methodInfo, ScriptAPI *scriptAPI)
	Constructor. More...
virtual	~Method ()
void	addInput (DataReader *input, const Unit *unit)
void	addOutput (DataWriter *output, const Unit *unit)
virtual void	execute (Logger &logger)
virtual bool	executeBool (Logger &logger)
virtual void	executeVoid (Logger &logger)
virtual FlexArray< DataWriter * > &	getOutputs ()
virtual FlexArray< const Unit * > &	getOutUnits ()
virtual FlexArray< OutputURI * > &	getOutputArgs ()

Protected Attributes
FlexArray< DataReader * >	inputs_
	Arguments for method;. More...
FlexArray< SettingReader * > &	settings_
	Method arguments;. More...
FlexArray< DataWriter * >	outputs_
	Return values for method;. More...
FlexArray< const Unit * >	outUnits_
	Units of return values for method;. More...
FlexArray< OutputURI * >	outputArgs_
	Non-null entries indicate outputArgs;. More...
ScriptNode *	scriptNode_
	Code for method;. More...

Private Member Functions
	Method (const Method &old)

Detailed Description

Wraps the inputs, outputs, and code for a method (i.e., initialize, run, etc) within a scripted component.

Constructor & Destructor Documentation

Method::Method	(	DefinedBehavior *	definedBehavior,
		MethodInfo *	methodInfo,
		ScriptAPI *	scriptAPI
	)

Constructor.

References MethodInfo::code_, Str::cStr(), FlexArray< T >::get(), InputInfo::getDataValue(), DefinedBehavior::getDefine(), Component::getLogger(), Component::getName(), DefineBehavior::getSettings(), OutputInfo::getUnit(), OutputInfo::getUri(), InputInfo::getUriPart(), MethodInfo::inputs_, inputs_, OutputInfo::isArg(), ScriptAPI::makeScriptFunction(), MethodInfo::methodName_, Slate::NewReader(), Slate::NewWriter(), outputArgs_, MethodInfo::outputs_, outputs_, outUnits_, FlexArray< T >::push(), scriptNode_, and FlexArrayBase::size().

Method::~Method ( )

virtual

Method::Method ( const Method &  old )

private

Member Function Documentation

void Method::addInput	(	DataReader *	input,
		const Unit *	unit
	)

void Method::addOutput	(	DataWriter *	output,
		const Unit *	unit
	)

References outputs_, outUnits_, and FlexArray< T >::push().

void Method::execute ( Logger &  logger )

virtual

References Syslog::CRITICAL, ScriptNode::execute(), inputs_, outputs_, outUnits_, scriptNode_, settings_, and Logger::syslog().

Referenced by DefinedBehavior::initialize(), DefinedBehavior::run(), and DefinedBehavior::uninitialize().

bool Method::executeBool ( Logger &  logger )

virtual

References Syslog::CRITICAL, ScriptNode::execute(), inputs_, scriptNode_, settings_, and Logger::syslog().

Referenced by DefinedBehavior::isSatisfied().

void Method::executeVoid ( Logger &  logger )

virtual

References Syslog::CRITICAL, ScriptNode::execute(), scriptNode_, and Logger::syslog().

Referenced by DefinedBehavior::initialize().

virtual FlexArray<OutputURI*>& Method::getOutputArgs ( )

inlinevirtual

References outputArgs_.

Referenced by DefinedBehavior::initialize().

virtual FlexArray<DataWriter*>& Method::getOutputs ( )

inlinevirtual

References outputs_.

Referenced by DefinedBehavior::initialize().

virtual FlexArray<const Unit*>& Method::getOutUnits ( )

inlinevirtual

References outUnits_.

Member Data Documentation

FlexArray<DataReader*> Method::inputs_

protected

Arguments for method;.

Referenced by execute(), executeBool(), and Method().

FlexArray<OutputURI*> Method::outputArgs_

protected

Non-null entries indicate outputArgs;.

Referenced by getOutputArgs(), and Method().

FlexArray<DataWriter*> Method::outputs_

protected

Return values for method;.

Referenced by addOutput(), execute(), getOutputs(), and Method().

FlexArray<const Unit*> Method::outUnits_

protected

Units of return values for method;.

Referenced by addOutput(), execute(), getOutUnits(), and Method().

ScriptNode* Method::scriptNode_

protected

Code for method;.

Referenced by execute(), executeBool(), executeVoid(), and Method().

FlexArray<SettingReader*>& Method::settings_

protected

Method arguments;.

Referenced by execute(), and executeBool().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/missionScript/Method.h
• /Volumes/ubuntu_share/lrauv-application/Source/missionScript/Method.cpp