3) Define the current frame class. This will be used for read access.

Inheritance diagram for makVrf::DtSubsurfaceStateComponentCurrentFrame:

Public Member Functions
	DtSubsurfaceStateComponentCurrentFrame (DtStateData *sd)

	CURRENTFRAME_ACCESSOR (double, underwaterVisibility, UnderwaterVisibility)

	CURRENTFRAME_ACCESSOR_BY_REF (DtVrfSubsurfaceLayerSet, subsurfaceLayers, SubsurfaceLayers)

	CURRENTFRAME_ACCESSOR (double, ambientWaterTemperature, AmbientWaterTemperature)

	CURRENTFRAME_ACCESSOR (int, priority, Priority)

	THERMOCLINE_GETTER (1, depth, Depth)

	THERMOCLINE_GETTER (1, thickness, Thickness)

	THERMOCLINE_GETTER (1, permeability, Permeability)

	THERMOCLINE_GETTER (2, depth, Depth)

	THERMOCLINE_GETTER (2, thickness, Thickness)

	THERMOCLINE_GETTER (2, permeability, Permeability)

	THERMOCLINE_GETTER (3, depth, Depth)

	THERMOCLINE_GETTER (3, thickness, Thickness)

	THERMOCLINE_GETTER (3, permeability, Permeability)

	THERMOCLINE_GETTER (4, depth, Depth)

	THERMOCLINE_GETTER (4, thickness, Thickness)

	THERMOCLINE_GETTER (4, permeability, Permeability)

	THERMOCLINE_GETTER (5, depth, Depth)

	THERMOCLINE_GETTER (5, thickness, Thickness)

	THERMOCLINE_GETTER (5, permeability, Permeability)

Public Member Functions inherited from DtStateComponentCurrentFrameTemplate< DtSubsurfaceStateComponent, DtSubsurfaceStateComponentNextFrame, DtSubsurfaceStateComponentData >
	DtStateComponentCurrentFrameTemplate (makVrf::DtStateData *sd)

virtual	~DtStateComponentCurrentFrameTemplate ()

const DtSubsurfaceStateComponentData &	frameState () const

Protected Member Functions
bool	thermoclineLayer (unsigned int index, DtVrfSubsurfaceLayer &layer) const

Protected Member Functions inherited from DtStateComponentCurrentFrameTemplate< DtSubsurfaceStateComponent, DtSubsurfaceStateComponentNextFrame, DtSubsurfaceStateComponentData >
void	advanceFrame (const DtSubsurfaceStateComponentData &data)

Additional Inherited Members
Protected Attributes inherited from DtStateComponentCurrentFrameTemplate< DtSubsurfaceStateComponent, DtSubsurfaceStateComponentNextFrame, DtSubsurfaceStateComponentData >
DtSubsurfaceStateComponentData	myData

Constructor & Destructor Documentation

makVrf::DtSubsurfaceStateComponentCurrentFrame::DtSubsurfaceStateComponentCurrentFrame ( DtStateData * sd )

inline

Member Function Documentation

makVrf::DtSubsurfaceStateComponentCurrentFrame::CURRENTFRAME_ACCESSOR	(	double	,
		underwaterVisibility	,
		UnderwaterVisibility
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::CURRENTFRAME_ACCESSOR_BY_REF	(	DtVrfSubsurfaceLayerSet	,
		subsurfaceLayers	,
		SubsurfaceLayers
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::CURRENTFRAME_ACCESSOR	(	double	,
		ambientWaterTemperature	,
		AmbientWaterTemperature
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::CURRENTFRAME_ACCESSOR	(	int	,
		priority	,
		Priority
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	1	,
		depth	,
		Depth
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	1	,
		thickness	,
		Thickness
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	1	,
		permeability	,
		Permeability
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	2	,
		depth	,
		Depth
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	2	,
		thickness	,
		Thickness
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	2	,
		permeability	,
		Permeability
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	3	,
		depth	,
		Depth
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	3	,
		thickness	,
		Thickness
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	3	,
		permeability	,
		Permeability
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	4	,
		depth	,
		Depth
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	4	,
		thickness	,
		Thickness
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	4	,
		permeability	,
		Permeability
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	5	,
		depth	,
		Depth
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	5	,
		thickness	,
		Thickness
	)

makVrf::DtSubsurfaceStateComponentCurrentFrame::THERMOCLINE_GETTER	(	5	,
		permeability	,
		Permeability
	)

bool makVrf::DtSubsurfaceStateComponentCurrentFrame::thermoclineLayer	(	unsigned int	index,
		DtVrfSubsurfaceLayer &	layer
	)		const

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfStateData/subsurfaceStateComponent.h