agxPowerLine::Connection Class Reference

#include <PowerLineUtils.h>

Inheritance diagram for agxPowerLine::Connection:

Public Member Functions
	Connection (agxPowerLine::PhysicalDimension *dimension, agxPowerLine::Connector *connector)
	Create a connection in or out of a physical dimension.
	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxPowerLine::Connection)
virtual void	clear ()
	clear all reference pointers
agxPowerLine::Connector *	getConnector ()
const agxPowerLine::Connector *	getConnector () const
agxPowerLine::PhysicalDimension *	getDimension ()
const agxPowerLine::PhysicalDimension *	getDimension () const
bool	isValid () const
virtual bool	restore (agxStream::StorageStream &str)
	Restores internal data from stream.
bool	setConnector (agxPowerLine::Connector *connector)
virtual bool	store (agxStream::StorageStream &str) const
	Stores internal data into stream.
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
	Connection ()
virtual	~Connection ()
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 ()

Protected Attributes
Connector *	m_connector
PhysicalDimension *	m_dimension
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

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.

Detailed Description

Definition at line 257 of file PowerLineUtils.h.

Constructor & Destructor Documentation

Connection() [1/2]

agxPowerLine::Connection::Connection	(	agxPowerLine::PhysicalDimension *	dimension,
		agxPowerLine::Connector *	connector
	)

Create a connection in or out of a physical dimension.

Parameters

dimension

- the dimension that is connecting

Connection() [2/2]

agxPowerLine::Connection::Connection ( )

protected

~Connection()

virtual agxPowerLine::Connection::~Connection ( )

protectedvirtual

Member Function Documentation

AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxPowerLine::Connection::AGXSTREAM_DECLARE_SERIALIZABLE_BASE

(

agxPowerLine::Connection

)

clear()

virtual void agxPowerLine::Connection::clear ( )

virtual

clear all reference pointers

create()

static agxStream::Serializable * agxPowerLine::Connection::create ( agxStream::InputArchive &  )

inlinestatic

Definition at line 313 of file PowerLineUtils.h.

getConnector() [1/2]

agxPowerLine::Connector * agxPowerLine::Connection::getConnector

(

)

Returns

a pointer to its connector.

getConnector() [2/2]

const agxPowerLine::Connector * agxPowerLine::Connection::getConnector

(

)

const

Returns

a pointer to its connector.

Referenced by agxPowerLine::detail::ConnectionIteratorTypes< PhysicalDimension * >::getTarget(), and agxPowerLine::detail::ConnectionIteratorTypes< const PhysicalDimension * >::getTarget().

getDimension() [1/2]

agxPowerLine::PhysicalDimension * agxPowerLine::Connection::getDimension

(

)

Returns

pointer to its dimension

getDimension() [2/2]

const agxPowerLine::PhysicalDimension * agxPowerLine::Connection::getDimension

(

)

const

Returns

pointer to its dimension

Referenced by agxPowerLine::detail::ConnectionIteratorTypes< Connector * >::getTarget(), and agxPowerLine::detail::ConnectionIteratorTypes< const Connector * >::getTarget().

isValid()

bool agxPowerLine::Connection::isValid

(

)

const

Returns

True if the connection has both a connector and a dimension.

restore()

virtual bool agxPowerLine::Connection::restore ( agxStream::StorageStream &  str )

virtual

Restores internal data from stream.

setConnector()

bool agxPowerLine::Connection::setConnector

(

agxPowerLine::Connector *

connector

)

Deprecated:

set pointer to a connector

store()

virtual bool agxPowerLine::Connection::store ( agxStream::StorageStream &  str ) const

virtual

Stores internal data into stream.

Member Data Documentation

m_connector

Connector* agxPowerLine::Connection::m_connector

protected

Definition at line 320 of file PowerLineUtils.h.

m_dimension

PhysicalDimension* agxPowerLine::Connection::m_dimension

protected

Definition at line 321 of file PowerLineUtils.h.

---

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

• PowerLineUtils.h