DtFederate Class Reference

Collaboration diagram for DtFederate:

Public Member Functions
	DtFederate (const char *type, const char *name, DtFederateHandle handle, unsigned long connHandle, int astntCompId, const char *fedHostName, const MAKRti::DtInetAddr &host, const DtSyncHashlist &syncList, DtHlaVersionId hlaVersion)
	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
virtual void	setHlaVersion (DtHlaVersionId version)
	Set/Get HLA version.
virtual DtHlaVersionId	hlaVersion () const
virtual void	setAssistantCompId (int id)
	Set/Get Assistant component ID.
virtual int	assistantCompId () const

Static Public Member Functions
static DtFederate *	create (const char *type, const char *name, DtFederateHandle handle, unsigned long connHandle, int astntCompId, const char *fedHostName, const MAKRti::DtInetAddr &host, const DtSyncHashlist &syncList, DtHlaVersionId hlaVersion)
	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
DtString	myDescription
DtHlaVersionId	myHlaVersion
int	myAstntCompId

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,
		DtFederateHandle	handle,
		unsigned long	connHandle,
		int	astntCompId,
		const char *	fedHostName,
		const MAKRti::DtInetAddr &	host,
		const DtSyncHashlist &	syncList,
		DtHlaVersionId	hlaVersion
	)

Constructor.

References addFederateSyncPt(), DtSyncPt::federates(), DtSyncHashlist::list(), myDescription, myFederateHostName, myHandle, myIsNamed, myName, myType, DtSyncPt::name(), NULL, and DtSyncPt::tag().

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 DtFederate().

int DtFederate::assistantCompId ( ) const

virtual

References myAstntCompId.

Referenced by DtFedExec::initializeRestore(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), and DtFedExec::restore().

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

static

Creates an instance of a DtFederate;.

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

Referenced by setCreatorFunction().

DtTime DtFederate::federateHeartbeat ( ) const

inlinevirtual

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

inlinevirtual

Set/Get connection handle.

References myConnectionHandle.

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

const char * DtFederate::getDescription ( ) const

inlinevirtual

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::initializeRestore(), DtFedExec::printFederates(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), and DtFedExec::restore().

char * DtFederate::getFederateHostName ( ) const

virtual

Set/Get federate host name.

References myFederateHostName.

Referenced by DtFedExec::initializeRestore(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), and DtFedExec::restore().

DtFederateHandle DtFederate::getHandle ( ) const

inlinevirtual

Get the federate handle.

References myHandle.

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

char * DtFederate::getName ( ) const

inlinevirtual

Get the federate name.

References myName.

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

char * DtFederate::getType ( ) const

inlinevirtual

Get the federate type.

References myType.

Referenced by DtFedExec::initializeRestore(), DtFedExec::printFederates(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processSyncPtAchievedEvent(), DtRtiexecObserverForAssistant::processTimeStateEvent(), DtFedExec::restore(), and DtFedExec::save().

DtHlaVersionId DtFederate::hlaVersion ( ) const

virtual

References myHlaVersion.

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

bool DtFederate::isNamed ( ) const

inlinevirtual

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::setAssistantCompId ( int  id )

virtual

Set/Get Assistant component ID.

References myAstntCompId.

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().

const DtSyncHashlist & DtFederate::syncPtList ( ) const

inlinevirtual

Return the sync point list.

References myHashlist.

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

Member Data Documentation

int DtFederate::myAstntCompId

protected

Referenced by assistantCompId(), and setAssistantCompId().

unsigned long DtFederate::myConnectionHandle

protected

Referenced by getConnectionHandle(), and setConnectionHandle().

DtString DtFederate::myDescription

protected

Referenced by DtFederate(), and getDescription().

MAKRti::DtInetAddr DtFederate::myFederateHost

protected

Referenced by getFederateHost(), and setFederateHost().

char* DtFederate::myFederateHostName

protected

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

DtFederateHandle DtFederate::myHandle

protected

Referenced by DtFederate(), and 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 DtFederate(), and isNamed().

char* DtFederate::myName

protected

Referenced by DtFederate(), and 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 DtFederate(), getType(), and ~DtFederate().

DtFederateCreator DtFederate::theCreator = NULL

staticprotected

Referenced by create(), and setCreatorFunction().

---

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

• federate.h
• federate.cxx