DtFederate Class Reference

Collaboration diagram for DtFederate:

List of all members.

Public Member Functions
	DtFederate (const char *type, const char *name, const char *fedHostName, DtFederateHandle handle, unsigned long connHandle, const DtSyncHashlist &list, const MAKRti::DtInetAddr &host, DtHlaVersionId hlaVersion, const MAKRti::DtInetAddr &webServerHost, int webServerPort)
	Constructor.
virtual	~DtFederate ()
	Destructor.
virtual void	setFederateSyncPtAchieved (const char *name, bool successful)
	Set/Get federate sync point achieved.
virtual bool	federateSyncPtAchieved (const char *name)
virtual bool	federateSyncPtAchievedSuccessfully (const char *name)
virtual void	addFederateSyncPt (const char *name, DtSyncPt *item)
	Add/Remove federate sync point.
virtual DtSyncPt *	removeFederateSyncPt (const char *name)
virtual char *	getType () const
	Get the federate type.
virtual char *	getName () const
	Get the federate name.
virtual bool	isNamed () const
	Get whether the federate was explicity named.
virtual DtFederateHandle	getHandle () const
	Get the federate handle.
virtual const char *	getDescription () const
	Get the federate description.
virtual unsigned long	getConnectionHandle () const
	Set/Get connection handle.
virtual void	setConnectionHandle (unsigned long handle)
virtual MAKRti::DtInetAddr	getFederateHost () const
	Set/Get federate host IP.
virtual void	setFederateHost (const MAKRti::DtInetAddr &hostAddr)
virtual char *	getFederateHostName () const
	Set/Get federate host name.
virtual void	setFederateHostName (char *hostname)
virtual const DtSyncHashlist &	syncPtList () const
	Return the sync point list.
virtual DtTime	federateHeartbeat () const
	Set/Get heartbeat.
virtual void	setFederateHeartbeat (MAKRti::DtTime time)
virtual void	setSaveStatus (DtSaveStatus status)
	Set/Get save status.
virtual DtSaveStatus	saveStatus () const
virtual void	setRestoreStatus (DtRestoreStatus status)
	Set/Get restore status.
virtual DtRestoreStatus	restoreStatus () const
void	setWebServerHost (const MAKRti::DtInetAddr &hostAddr)
	Set/Get web server host address for this federate.
MAKRti::DtInetAddr	getWebServerHost () const
void	setWebServerPort (int port)
	Set/Get web server port for this federate.
int	getWebServerPort () const
virtual void	setHlaVersion (DtHlaVersionId version)
	Set/Get HLA version.
virtual DtHlaVersionId	hlaVersion () const
Static Public Member Functions
static DtFederate *	create (const char *type, const char *name, const char *fedHostName, DtFederateHandle handle, unsigned long connHandle, const DtSyncHashlist &list, const MAKRti::DtInetAddr &host, DtHlaVersionId hlaVersion, const MAKRti::DtInetAddr &webServerHost, int webServerPort)
	Creates an instance of a DtFederate;.
static void	setCreatorFunction (DtFederateCreator creator)
	Call this function to set an alternate creator function With this function, users can replace this DtFederate with their own derived class.
Protected Attributes
char *	myType
char *	myName
bool	myIsNamed
char *	myFederateHostName
MAKRti::DtTime	myHeartbeat
DtFederateHandle	myHandle
DtSaveStatus	mySaveStatus
DtRestoreStatus	myRestoreStatus
unsigned long	myConnectionHandle
DtSyncHashlist	myHashlist
MAKRti::DtInetAddr	myFederateHost
MAKRti::DtInetAddr	myWebServerHost
int	myWebServerPort
DtString	myDescription
DtHlaVersionId	myHlaVersion
Static Protected Attributes
static DtFederateCreator	theCreator = NULL
Private Member Functions
	DtFederate (const DtFederate &)
	Not implemented.
DtFederate &	operator= (const DtFederate &)
	Not implemented.

---

Constructor & Destructor Documentation

DtFederate::DtFederate	(	const char *	type,
		const char *	name,
		const char *	fedHostName,
		DtFederateHandle	handle,
		unsigned long	connHandle,
		const DtSyncHashlist &	list,
		const MAKRti::DtInetAddr &	host,
		DtHlaVersionId	hlaVersion,
		const MAKRti::DtInetAddr &	webServerHost,
		int	webServerPort
	)

Constructor.

Referenced by create().

DtFederate::~DtFederate

(

)

[virtual]

Destructor.

References DtSyncHashlist::empty(), myFederateHostName, myHashlist, and myType.

DtFederate::DtFederate

(

const DtFederate &

)

[private]

Not implemented.

---

Member Function Documentation

void DtFederate::addFederateSyncPt	(	const char *	name,
		DtSyncPt *	item
	)		[virtual]

Add/Remove federate sync point.

References DtSyncHashlist::addSyncPoint(), and myHashlist.

Referenced by DtFedExec::createSyncPoint(), and DtFedExec::restore().

DtFederate * DtFederate::create	(	const char *	type,
		const char *	name,
		const char *	fedHostName,
		DtFederateHandle	handle,
		unsigned long	connHandle,
		const DtSyncHashlist &	list,
		const MAKRti::DtInetAddr &	host,
		DtHlaVersionId	hlaVersion,
		const MAKRti::DtInetAddr &	webServerHost,
		int	webServerPort
	)		[static]

Creates an instance of a DtFederate;.

References DtFederate(), hlaVersion(), and theCreator.

Referenced by setCreatorFunction().

DtTime DtFederate::federateHeartbeat

(

)

const [inline, virtual]

Set/Get heartbeat.

References myHeartbeat.

Referenced by DtFedExec::tickFederates().

bool DtFederate::federateSyncPtAchieved

(

const char *

name

)

[virtual]

References DtSyncPt::achieved(), DtSyncHashlist::lookupSyncPoint(), myHashlist, and NULL.

Referenced by DtFedExec::sendSyncPointStatusReport(), and DtFedExec::synchronized().

bool DtFederate::federateSyncPtAchievedSuccessfully

(

const char *

name

)

[virtual]

References DtSyncHashlist::lookupSyncPoint(), myHashlist, NULL, and DtSyncPt::successful().

Referenced by DtFedExec::synchronized().

unsigned long DtFederate::getConnectionHandle

(

)

const [inline, virtual]

Set/Get connection handle.

References myConnectionHandle.

Referenced by DtFedExec::deleteFederate(), DtFedExec::federateHandleOfConnection(), DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtFedExec::processRestoreBegun(), DtRtiexecObserverForAssistant::processTimeStateEvent(), DtFedExec::restoreFederateConnection(), and DtFedExec::save().

const char * DtFederate::getDescription

(

)

const [inline, virtual]

Get the federate description.

References myDescription.

Referenced by DtRtiExec::processDisconnect(), DtFedExec::processJoinConfirm(), DtFedExec::processResign(), DtFedExec::removeFederateConnection(), DtFedExec::restoreFederateConnection(), and DtFedExec::tickFederates().

DtInetAddr DtFederate::getFederateHost

(

)

const [virtual]

Set/Get federate host IP.

References myFederateHost.

Referenced by DtFedExec::printFederates(), DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtFedExec::processRestoreBegun(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

char * DtFederate::getFederateHostName

(

)

const [virtual]

Set/Get federate host name.

References myFederateHostName.

Referenced by DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

DtFederateHandle DtFederate::getHandle

(

)

const [inline, virtual]

Get the federate handle.

References myHandle.

Referenced by DtFedExec::addFederate(), DtFedExec::createSyncPoint(), DtFedExec::federateHandleOfConnection(), DtFedExec::printFederates(), DtRtiexecObserverForAssistant::processFederateDisconnectedEvent(), DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectFailedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectSucceededEvent(), DtRtiexecObserverForWebService::processFederateResignedEvent(), DtRtiexecObserverForAssistant::processFederateResignedEvent(), DtFedExec::processInitiatedSave(), DtFedExec::processJoinConfirm(), DtFedExec::processQueryRestoreStatus(), DtFedExec::processQuerySaveStatus(), DtFedExec::processRestoreBegun(), DtRtiexecObserverForWebService::processSyncPtAchievedEvent(), DtRtiexecObserverForAssistant::processSyncPtAchievedEvent(), DtRtiexecObserverForWebService::processSyncPtRegisteredEvent(), DtRtiexecObserverForAssistant::processSyncPtRegisteredEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), DtFedExec::removeFederateConnection(), DtFedExec::restoreFederateConnection(), DtFedExec::save(), DtFedExec::sendSyncPointStatusReport(), DtFedExec::synchronized(), and DtFedExec::tickFederates().

char * DtFederate::getName

(

)

const [inline, virtual]

Get the federate name.

References myName.

Referenced by DtFedExec::addFederate(), DtFedExec::deleteFederate(), DtFedExec::printFederates(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

char * DtFederate::getType

(

)

const [inline, virtual]

Get the federate type.

References myType.

Referenced by DtFedExec::printFederates(), DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtFedExec::processRestoreBegun(), DtRtiexecObserverForAssistant::processSyncPtAchievedEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), DtFedExec::save(), and DtFedExec::verifyRestore().

DtInetAddr DtFederate::getWebServerHost

(

)

const

References myWebServerHost.

Referenced by DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

int DtFederate::getWebServerPort

(

)

const

References myWebServerPort.

Referenced by DtRtiexecObserverForWebService::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

DtHlaVersionId DtFederate::hlaVersion

(

)

const [virtual]

References myHlaVersion.

Referenced by create(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

bool DtFederate::isNamed

(

)

const [inline, virtual]

Get whether the federate was explicity named.

References myIsNamed.

Referenced by DtFedExec::printFederates().

DtFederate& DtFederate::operator=

(

const DtFederate &

)

[private]

Not implemented.

DtSyncPt * DtFederate::removeFederateSyncPt

(

const char *

name

)

[virtual]

References myHashlist, and DtSyncHashlist::remove().

Referenced by DtFedExec::retireSyncPoint().

DtRestoreStatus DtFederate::restoreStatus

(

)

const [virtual]

References myRestoreStatus.

Referenced by DtFedExec::processQueryRestoreStatus().

DtSaveStatus DtFederate::saveStatus

(

)

const [virtual]

References mySaveStatus.

Referenced by DtFedExec::processQuerySaveStatus().

void DtFederate::setConnectionHandle

(

unsigned long

handle

)

[virtual]

References myConnectionHandle.

Referenced by DtFedExec::restoreFederateConnection().

void DtFederate::setCreatorFunction

(

DtFederateCreator

creator

)

[static]

Call this function to set an alternate creator function With this function, users can replace this DtFederate with their own derived class.

References create(), DtBindCreator(), and theCreator.

void DtFederate::setFederateHeartbeat

(

MAKRti::DtTime

time

)

[virtual]

References myHeartbeat.

Referenced by DtFedExec::endRestore(), DtFedExec::endSave(), DtFedExec::processAlive(), DtFedExec::processJoinConfirm(), and DtFedExec::resetClockForHeartBeat().

void DtFederate::setFederateHost

(

const MAKRti::DtInetAddr &

hostAddr

)

[virtual]

References myFederateHost.

void DtFederate::setFederateHostName

(

char *

hostname

)

[virtual]

References myFederateHostName.

void DtFederate::setFederateSyncPtAchieved	(	const char *	name,
		bool	successful
	)		[virtual]

Set/Get federate sync point achieved.

References DtSyncHashlist::lookupSyncPoint(), myHashlist, NULL, DtSyncPt::setAchieved(), and DtSyncPt::setSuccessful().

Referenced by DtFedExec::processAchievedSyncPoint(), and DtFedExec::processResign().

void DtFederate::setHlaVersion

(

DtHlaVersionId

version

)

[virtual]

Set/Get HLA version.

References myHlaVersion.

void DtFederate::setRestoreStatus

(

DtRestoreStatus

status

)

[virtual]

Set/Get restore status.

References myRestoreStatus.

Referenced by DtFedExec::addFederate(), DtFedExec::endRestore(), DtFedExec::processRestoreBegun(), DtFedExec::processRestoreComplete(), and DtFedExec::processRestoreRequest().

void DtFederate::setSaveStatus

(

DtSaveStatus

status

)

[virtual]

Set/Get save status.

References mySaveStatus.

Referenced by DtFedExec::addFederate(), DtFedExec::endSave(), DtFedExec::initiateSave(), DtFedExec::processInitiatedSave(), DtFedExec::processSaveBegun(), and DtFedExec::processSaveComplete().

void DtFederate::setWebServerHost

(

const MAKRti::DtInetAddr &

hostAddr

)

Set/Get web server host address for this federate.

References myWebServerHost.

void DtFederate::setWebServerPort

(

int

port

)

Set/Get web server port for this federate.

References myWebServerPort.

const DtSyncHashlist & DtFederate::syncPtList

(

)

const [inline, virtual]

Return the sync point list.

References myHashlist.

Referenced by DtFedExec::processResign(), and DtFedExec::save().

---

Member Data Documentation

unsigned long DtFederate::myConnectionHandle [protected]

Referenced by getConnectionHandle(), and setConnectionHandle().

DtString DtFederate::myDescription [protected]

Referenced by getDescription().

MAKRti::DtInetAddr DtFederate::myFederateHost [protected]

Referenced by getFederateHost(), and setFederateHost().

char* DtFederate::myFederateHostName [protected]

Referenced by getFederateHostName(), setFederateHostName(), and ~DtFederate().

DtFederateHandle DtFederate::myHandle [protected]

Referenced by getHandle().

DtSyncHashlist DtFederate::myHashlist [protected]

Referenced by addFederateSyncPt(), federateSyncPtAchieved(), federateSyncPtAchievedSuccessfully(), removeFederateSyncPt(), setFederateSyncPtAchieved(), syncPtList(), and ~DtFederate().

MAKRti::DtTime DtFederate::myHeartbeat [protected]

Referenced by federateHeartbeat(), and setFederateHeartbeat().

DtHlaVersionId DtFederate::myHlaVersion [protected]

Referenced by hlaVersion(), and setHlaVersion().

bool DtFederate::myIsNamed [protected]

Referenced by isNamed().

char* DtFederate::myName [protected]

Referenced by getName().

DtRestoreStatus DtFederate::myRestoreStatus [protected]

Referenced by restoreStatus(), and setRestoreStatus().

DtSaveStatus DtFederate::mySaveStatus [protected]

Referenced by saveStatus(), and setSaveStatus().

char* DtFederate::myType [protected]

Referenced by getType(), and ~DtFederate().

MAKRti::DtInetAddr DtFederate::myWebServerHost [protected]

Referenced by getWebServerHost(), and setWebServerHost().

int DtFederate::myWebServerPort [protected]

Referenced by getWebServerPort(), and setWebServerPort().

DtFederateCreator DtFederate::theCreator = NULL [static, protected]

Referenced by create(), and setCreatorFunction().

---

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

• federate.h
• federate.cxx