Netcage::FloaterLinVerification Class Reference

Inheritance diagram for Netcage::FloaterLinVerification:

Collaboration diagram for Netcage::FloaterLinVerification:

Public Member Functions
	FloaterLinVerification (const string &simObjectName, ISimObjectCreator *const creator)
	Reads parameters, registers states, input/output ports and shared resources. More...
virtual void	FinalSetup (const double T, const double *const X, ISimObjectCreator *const pCreator)
void	OdeFcn (const double T, const double *const X, double *const XDot, const bool IsMajorTimeStep)
	Computes object derivatives as a function of time, states and input ports. More...
const double *	Position (const double T, const double *const X)
	Output port. Returns current position. More...
const double *	Velocity (const double T, const double *const X)
	Output port. Returns current velocity. More...

Protected Attributes
int	PositionIndex
int	VelocityIndex
	The index of the position state in the state array.
int	m_numElements
	The index of the velocity state in the state array.
CEnvironment *	m_Environment
	Number of elements in visualization.

Constructor & Destructor Documentation

FloaterLinVerification()

Netcage::FloaterLinVerification::FloaterLinVerification	(	const string &	simObjectName,
		ISimObjectCreator *const	creator
	)

The constructor performs all initial setup for a floating collar simobject. Reading in parameters, setting up communication interface i.e. output ports, input ports, and states, plus additional 'one time only' resource setup.

Reads in "Mass2D" parameter and tests for validity. Registers communication interface; "Velocity"/"Position" output ports. Registers states; "Velocity"/"Position"

Parameters

[in]	simObjectName	-> The name of the simobject
[in]	creator	-> Retrieve parameters. Register states, ports and shared resources

Member Function Documentation

OdeFcn()

void Netcage::FloaterLinVerification::OdeFcn	(	const double	T,
		const double *const	X,
		double *const	XDot,
		const bool	IsMajorTimeStep
	)

Returns state derivatives. Velocity as derivative of position, (external_force+gravity)/mass as derivative of velocity

Parameters

[in]	T	-> Current simulation time
[in]	X	-> Current simulation state
[out]	XDot	-> State derivatives
[in]	IsMajorTimeStep	-> Is this a major time step?

Position()

const double * Netcage::FloaterLinVerification::Position	(	const double	T,
		const double *const	X
	)

See PortDefs.h

Parameters

[in]	T	-> Current simulation time
[in]	X	-> Current simulation state

Returns

-> Address of current position

Velocity()

const double * Netcage::FloaterLinVerification::Velocity	(	const double	T,
		const double *const	X
	)

See PortDefs.h

Parameters

[in]	T	-> Current simulation time
[in]	X	-> Current simulation state

Returns

-> Address of current velocity

---

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

• reloadrepos/fhsim_fishery/src/netcage/FloaterLinVerification.h