agxCable::PathRoute Class Reference

A route that creates a path roughly following the routing nodes. More...

#include <Route.h>

Inheritance diagram for agxCable::PathRoute:

Public Member Functions
	PathRoute (agx::Real targetResolution)
	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxCable::PathRoute)
virtual agxCable::RouteInitializationReport	initialize () override
virtual void	restore (agxStream::InputArchive &in) override
virtual agxCable::RouteInitializationReport	tryInitialize () override
Public Member Functions inherited from agxCable::HomogeneousSegmentsRoute
bool	add (agxCable::RoutingNode *node)
	AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxCable::Route)
agx::Real	getMaxAllowedError () const
agx::Real	getResolution () const
const agxCable::RoutingNodeRefVector &	getRouteNodes () const
const agxCable::CableSegmentRefVector &	getSegments () const
virtual agxCable::RouteInitializationReport	initialize ()=0
virtual void	restore (agxStream::InputArchive &in) override
void	setMaxAllowedError (agx::Real error)
virtual void	store (agxStream::OutputArchive &out) const override
virtual agxCable::RouteInitializationReport	tryInitialize ()=0
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.
Public Member Functions inherited from agxStream::Serializable
virtual	~Serializable ()
	Destructor for normal C++ use but hidden from SWIG bindings.
virtual const char *	getClassName () const
bool	getEnableSerialization () const
bool	getEnableUuidGeneration ()
agx::UInt32	getIndex () const
	This index is given at creation of this object.
virtual StorageAgent *	getStorageAgent () const =0
agx::Uuid	getUuid () const
bool	isFinished () const
void	setEnableSerialization (bool flag)
	Set to false to disable serialization of this object.
void	setFinished ()
	Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
void	setUuid (const agx::Uuid &uuid)
	Explicitly set a Uuid on a serializable object.

Static Public Member Functions
static agxStream::Serializable *	create (agxStream::InputArchive &)
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Public Member Functions inherited from agxStream::Serializable
static void	setEnableUuidGeneration (bool flag)
	Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.

Protected Member Functions
	PathRoute ()
	~PathRoute ()
Protected Member Functions inherited from agxCable::HomogeneousSegmentsRoute
	HomogeneousSegmentsRoute ()
	HomogeneousSegmentsRoute (agx::Real resolution, agx::Real maxAllowedError)
	HomogeneousSegmentsRoute (agx::Real resolution, agx::Real originalResolution, agx::Real maxAllowedError, agxCable::RoutingNodeRefVector &&routingNodes, agxCable::CableSegmentRefVector &&segments)
virtual	~HomogeneousSegmentsRoute ()
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const
Protected Member Functions inherited from agxStream::Serializable
	Serializable ()
	Default constructor.
	Serializable (const Serializable &other)
	Copy constructor.
void	generateUuid ()

Additional Inherited Members
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.
Protected Attributes inherited from agxCable::HomogeneousSegmentsRoute
agx::Real	m_maxAllowedError
agx::Real	m_originalResolution
	The resolution supplied to the constructor. Resolution search always start here.
agx::Real	m_resolution
	The current resolution, updated by running the segmentation algorithm.
agxCable::RoutingNodeRefVector	m_routingNodes
agxCable::CableSegmentRefVector	m_segments
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

A route that creates a path roughly following the routing nodes.

Routing node positions are not strictly adhered to, and routing nodes are not included in the final cable.

Definition at line 136 of file Route.h.

Constructor & Destructor Documentation

PathRoute() [1/2]

agxCable::PathRoute::PathRoute ( agx::Real  targetResolution )

explicit

PathRoute() [2/2]

agxCable::PathRoute::PathRoute ( )

protected

~PathRoute()

agxCable::PathRoute::~PathRoute ( )

protected

Member Function Documentation

AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxCable::PathRoute::AGXSTREAM_DECLARE_SERIALIZABLE_BASE

(

agxCable::PathRoute

)

create()

static agxStream::Serializable * agxCable::PathRoute::create ( agxStream::InputArchive &  )

inlinestatic

Definition at line 144 of file Route.h.

initialize()

virtual agxCable::RouteInitializationReport agxCable::PathRoute::initialize ( )

overridevirtual

Implements agxCable::HomogeneousSegmentsRoute.

restore()

virtual void agxCable::HomogeneousSegmentsRoute::restore ( agxStream::InputArchive &  in )

overridevirtual

Reimplemented from agxCable::HomogeneousSegmentsRoute.

tryInitialize()

virtual agxCable::RouteInitializationReport agxCable::PathRoute::tryInitialize ( )

overridevirtual

Implements agxCable::HomogeneousSegmentsRoute.

---

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

• Route.h