osg::ConnectionType Class Reference
[Network]

Types for Connection, see XXX for details. More...

#include <OSGConnectionType.h>

List of all members.

Public Types
Types
typedef PointConnection *(*	CreatePointFunction )(void)
typedef GroupConnection *(*	CreateGroupFunction )(void)
Public Member Functions
Constructors
	ConnectionType (CreateGroupFunction, const std::string &name)
	ConnectionType (CreatePointFunction, const std::string &name)
	ConnectionType (const ConnectionType &source)
Destructor
virtual	~ConnectionType (void)
Get
std::string	getName (void) const
CreateGroupFunction	getCreateGroup (void) const
CreatePointFunction	getCreatePoint (void) const
creation
PointConnection *	createPoint (void)
GroupConnection *	createGroup (void)
Assignment
ConnectionType &	operator= (const ConnectionType &source)
Comparison
bool	operator< (const ConnectionType &other) const
bool	operator== (const ConnectionType &other) const
bool	operator!= (const ConnectionType &other) const
Protected Attributes
CreateGroupFunction	_createGroup
CreatePointFunction	_createPoint
std::string	_name

---

Detailed Description

A connection type describes a network connection and provides an interface for dynamic connection creation.

Definition at line 57 of file OSGConnectionType.h.

---

Member Typedef Documentation

typedef PointConnection*(* osg::ConnectionType::CreatePointFunction)(void)

typedef GroupConnection*(* osg::ConnectionType::CreateGroupFunction)(void)

---

Constructor & Destructor Documentation

ConnectionType::ConnectionType	(	CreateGroupFunction	createGroup,
		const std::string &	name
	)

Constructor. A new connection with the given name is registered. To create a new connection, the given functions for group and point are called

Definition at line 66 of file OSGConnectionType.cpp.

References osg::ConnectionFactory::addGroupType(), and osg::ConnectionFactory::the().

                                                                      :
    _createGroup(createGroup),
    _createPoint(NULL),
    _name(name)
{
    ConnectionFactory::the().addGroupType(this);
}

ConnectionType::ConnectionType	(	CreatePointFunction	createPoint,
		const std::string &	name
	)

Constructor. A new connection with the given name is registered. To create a new connection, the given functions for group and point are called

Definition at line 79 of file OSGConnectionType.cpp.

References osg::ConnectionFactory::addPointType(), and osg::ConnectionFactory::the().

                                                                      :
    _createGroup(NULL),
    _createPoint(createPoint),
    _name(name)
{
    ConnectionFactory::the().addPointType(this);
}

osg::ConnectionType::ConnectionType

(

const ConnectionType &

source

)

Constructor. A new connection with the given name is registered. To create a new connection, the given functions for group and point are called

ConnectionType::~ConnectionType

(

void

)

[virtual]

Destructor. Unregister the connection from the factory

Definition at line 93 of file OSGConnectionType.cpp.

References _createGroup, _createPoint, osg::ConnectionFactory::subGroupType(), osg::ConnectionFactory::subPointType(), and osg::ConnectionFactory::the().

{
    if(_createGroup)
        ConnectionFactory::the().subGroupType(this);
    if(_createPoint)
        ConnectionFactory::the().subPointType(this);
}

---

Member Function Documentation

std::string ConnectionType::getName

(

void

)

const

get conneciton name

Definition at line 147 of file OSGConnectionType.cpp.

References _name.

Referenced by osg::ClusterServer::acceptClient(), osg::ConnectionFactory::addGroupType(), osg::ConnectionFactory::addPointType(), osg::ConnectionFactory::subGroupType(), and osg::ConnectionFactory::subPointType().

{
    return _name;
}

ConnectionType::CreateGroupFunction ConnectionType::getCreateGroup

(

void

)

const

get conneciton create function

Definition at line 154 of file OSGConnectionType.cpp.

References _createGroup.

{
    return _createGroup;
}

ConnectionType::CreatePointFunction ConnectionType::getCreatePoint

(

void

)

const

get conneciton create function

Definition at line 161 of file OSGConnectionType.cpp.

References _createPoint.

{
    return _createPoint;
}

PointConnection * ConnectionType::createPoint

(

void

)

create Connection

Definition at line 178 of file OSGConnectionType.cpp.

References _createPoint.

{
    return _createPoint();
}

GroupConnection * ConnectionType::createGroup

(

void

)

create Connection

Definition at line 171 of file OSGConnectionType.cpp.

References _createGroup.

{
    return _createGroup();
}

ConnectionType & ConnectionType::operator=

(

const ConnectionType &

source

)

assignment

Definition at line 106 of file OSGConnectionType.cpp.

References _createGroup, _createPoint, and _name.

{
    if(this == &source)
        return *this;

    _name        = source._name;
    _createGroup = source._createGroup;
    _createPoint = source._createPoint;
    return *this;
}

bool ConnectionType::operator<

(

const ConnectionType &

other

)

const

less

Definition at line 122 of file OSGConnectionType.cpp.

References _name.

{
    return _name < other._name;
}

bool ConnectionType::operator==

(

const ConnectionType &

other

)

const

equal

Definition at line 129 of file OSGConnectionType.cpp.

References _name.

{
    return _name == other._name;
}

bool ConnectionType::operator!=

(

const ConnectionType &

other

)

const

unequal

Definition at line 136 of file OSGConnectionType.cpp.

{
    return ! (*this == other);
}

---

Member Data Documentation

CreateGroupFunction osg::ConnectionType::_createGroup [protected]

Definition at line 124 of file OSGConnectionType.h.

Referenced by createGroup(), getCreateGroup(), operator=(), and ~ConnectionType().

CreatePointFunction osg::ConnectionType::_createPoint [protected]

Definition at line 125 of file OSGConnectionType.h.

Referenced by createPoint(), getCreatePoint(), operator=(), and ~ConnectionType().

std::string osg::ConnectionType::_name [protected]

Definition at line 126 of file OSGConnectionType.h.

Referenced by getName(), operator<(), operator=(), and operator==().

---

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

• OSGConnectionType.h
• OSGConnectionType.cpp