agxTerrain::GroundCollapse::GroundCollapseResult Class Reference

#include <GroundCollapseResult.h>

Inheritance diagram for agxTerrain::GroundCollapse::GroundCollapseResult:

Public Member Functions
	GroundCollapseResult ()
	Default constructor.
agx::Real	getCriticalFos () const
int	getCriticalFosIndex () const
agx::UInt	getNumFailed () const
agx::UInt	getNumSolved () const
FailureSurfaceResultVector &	getResults ()
agx::UInt	getTotalNumSurfaceVoxels () const
Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.
	Referenced (const Referenced &)
template<typename T >
T *	as ()
	Subclass casting.
template<typename T >
const T *	as () const
template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.
template<typename T >
const T *	asSafe () const
int	getReferenceCount () const
template<typename T >
bool	is () const
	Subclass test.
Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.
void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

Protected Member Functions
virtual	~GroundCollapseResult ()
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const

Protected Attributes
agx::Real	m_criticalFos
int	m_criticalFosIndex
agx::UInt	m_numFailed
agx::UInt	m_numSolved
FailureSurfaceResultVector	m_results
agx::UInt	m_totSurfaceVoxels
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()
static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.

Detailed Description

Definition at line 147 of file GroundCollapseResult.h.

Constructor & Destructor Documentation

GroundCollapseResult()

agxTerrain::GroundCollapse::GroundCollapseResult::GroundCollapseResult

(

)

Default constructor.

~GroundCollapseResult()

virtual agxTerrain::GroundCollapse::GroundCollapseResult::~GroundCollapseResult ( )

inlineprotectedvirtual

Definition at line 195 of file GroundCollapseResult.h.

Member Function Documentation

getCriticalFos()

agx::Real agxTerrain::GroundCollapse::GroundCollapseResult::getCriticalFos

(

)

const

Returns

the critical factor of saftey for all processed failure surfaces.

getCriticalFosIndex()

int agxTerrain::GroundCollapse::GroundCollapseResult::getCriticalFosIndex

(

)

const

Returns

the index to the failure surface in the result vector that contains the critical factor of saftey. note: get the result vector from the getResults() function.

getNumFailed()

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::getNumFailed

(

)

const

Returns

number of failure surfaces that have failed, i.e where we have soil collapse.

getNumSolved()

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::getNumSolved

(

)

const

Returns

number of solved failure surfaces.

getResults()

FailureSurfaceResultVector & agxTerrain::GroundCollapse::GroundCollapseResult::getResults

(

)

Returns

a vector of FailureSurfaceResult that contains the results for all processed failure surfaces in the ground collapse calculations.

getTotalNumSurfaceVoxels()

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::getTotalNumSurfaceVoxels

(

)

const

Returns

the total sum of voxels in all failure surfaces processed by the ground collapse calculations.

Member Data Documentation

m_criticalFos

agx::Real agxTerrain::GroundCollapse::GroundCollapseResult::m_criticalFos

protected

Definition at line 202 of file GroundCollapseResult.h.

m_criticalFosIndex

int agxTerrain::GroundCollapse::GroundCollapseResult::m_criticalFosIndex

protected

Definition at line 201 of file GroundCollapseResult.h.

m_numFailed

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::m_numFailed

protected

Definition at line 199 of file GroundCollapseResult.h.

m_numSolved

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::m_numSolved

protected

Definition at line 198 of file GroundCollapseResult.h.

m_results

FailureSurfaceResultVector agxTerrain::GroundCollapse::GroundCollapseResult::m_results

protected

Definition at line 203 of file GroundCollapseResult.h.

m_totSurfaceVoxels

agx::UInt agxTerrain::GroundCollapse::GroundCollapseResult::m_totSurfaceVoxels

protected

Definition at line 200 of file GroundCollapseResult.h.

---

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

• GroundCollapseResult.h