WsfBMZoneRecord Class Reference

#include <WsfBMZoneRecord.hpp>

Inheritance diagram for WsfBMZoneRecord:

Collaboration diagram for WsfBMZoneRecord:

Public Member Functions
	WsfBMZoneRecord (const il::eZoneType type_enum, const std::string &type_str, const il::tZonePriority &priority, WsfZoneDefinition *zone, WsfSimulation *sim_ptr)
virtual std::string	getName () const
virtual il::positionRecord	getCenterPoint () const
virtual double	getDistanceToZone (const il::positionRecord &position) const
virtual double	getDistanceToZoneCenter (const il::positionRecord &position) const
virtual bool	getClosestPointInZone (const il::positionRecord &position, il::positionRecord &zonePoint) const
virtual bool	isInsideZone (const il::positionRecord &position) const
virtual bool	isProjectedInsideZone (const il::positionRecord &position1, const il::positionRecord &position2) const
virtual bool	isProjectedInsideZone (const il::positionRecord &position, const double heading_rads) const
Public Member Functions inherited from WsfBMUnmanagedTypeWrapper< WsfZoneDefinition >
	WsfBMUnmanagedTypeWrapper (const std::string &script_class_name)
virtual void	SetData (WsfZoneDefinition *data_to_wrap)
Public Member Functions inherited from WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >
	WsfBMTypeWrapper (const std::string &script_class_name)
virtual WsfBMTypeWrapper *	Clone () const
virtual const char *	GetScriptClassName () const
virtual tType	GetRawPtr () const
virtual bool	IsValidRef () const
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
virtual bool	ProcessInput (UtInput &aInput)
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Protected Attributes
WsfSimulation *	m_sim_ptr
Protected Attributes inherited from WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >
std::string	m_script_class_name
WsfZoneDefinition *	m_wrapped_ptr

Additional Inherited Members
Public Types inherited from WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >
typedef WsfZoneDefinition *	tType
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

WsfBMZoneRecord()

WsfBMZoneRecord::WsfBMZoneRecord	(	const il::eZoneType	type_enum,
		const std::string &	type_str,
		const il::tZonePriority &	priority,
		WsfZoneDefinition *	zone,
		WsfSimulation *	sim_ptr )

References m_sim_ptr, and WsfBMUnmanagedTypeWrapper< WsfZoneDefinition >::WsfBMUnmanagedTypeWrapper().

Member Function Documentation

getCenterPoint()

il::positionRecord WsfBMZoneRecord::getCenterPoint ( ) const

virtual

References ZoneUtils::GetZoneCentroid(), WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::IsValidRef(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

getClosestPointInZone()

bool WsfBMZoneRecord::getClosestPointInZone ( const il::positionRecord & position, il::positionRecord & zonePoint ) const

virtual

References ZoneUtils::GetClosestPointInZone(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

getDistanceToZone()

double WsfBMZoneRecord::getDistanceToZone ( const il::positionRecord & position ) const

virtual

References ZoneUtils::GetDistanceFromPointToZone(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

getDistanceToZoneCenter()

double WsfBMZoneRecord::getDistanceToZoneCenter ( const il::positionRecord & position ) const

virtual

References ZoneUtils::GetDistanceFromPointToZoneCenter(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

getName()

std::string WsfBMZoneRecord::getName ( ) const

virtual

References WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::IsValidRef(), and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

isInsideZone()

bool WsfBMZoneRecord::isInsideZone ( const il::positionRecord & position ) const

virtual

References m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

isProjectedInsideZone() [1/2]

bool WsfBMZoneRecord::isProjectedInsideZone ( const il::positionRecord & position, const double heading_rads ) const

virtual

References ZoneUtils::isProjectedInsideZonePointHeading(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

isProjectedInsideZone() [2/2]

bool WsfBMZoneRecord::isProjectedInsideZone ( const il::positionRecord & position1, const il::positionRecord & position2 ) const

virtual

References ZoneUtils::isProjectedInsideZone2Points(), m_sim_ptr, and WsfBMTypeWrapper< WsfZoneDefinition, WsfZoneDefinition * >::m_wrapped_ptr.

Member Data Documentation

m_sim_ptr

WsfSimulation* WsfBMZoneRecord::m_sim_ptr

protected

Referenced by getCenterPoint(), getClosestPointInZone(), getDistanceToZone(), getDistanceToZoneCenter(), isInsideZone(), isProjectedInsideZone(), isProjectedInsideZone(), and WsfBMZoneRecord().

---

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

• WsfBMZoneRecord.hpp
• WsfBMZoneRecord.cpp