com.mak.vrlj.object.EmbeddedIdentifier Class Reference

A tuple which uniquely identifies a embedded object. More...

Inheritance diagram for com.mak.vrlj.object.EmbeddedIdentifier:

Collaboration diagram for com.mak.vrlj.object.EmbeddedIdentifier:

Public Member Functions
	EmbeddedIdentifier (GlobalObjectDesignator hostGod, short embeddedId, String idType)
	Create an EmbeddedIdentifier. More...
	EmbeddedIdentifier (String id)
	Create an EmbeddedIdentifier from a managed interface string. More...
short	getEmbeddedId ()
GlobalObjectDesignator	getHost ()
EntityIdentifier	getHostEntityIdentifier ()
	Return the host ID as an EntityIdentifier if possible; otherwise, invalid ID. More...
String	getIdentifierType ()
boolean	isValid ()
	Validate this identifier. More...
Public Member Functions inherited from com.mak.vrlj.object.GlobalObjectDesignator
	GlobalObjectDesignator (String id)
	Create a GlobalObjectDesignator. More...
EntityIdentifier	getEntityIdentifier ()
void	decode (ByteBuffer myMessageBuffer)
void	encode (ByteBuffer myMessageBuffer)
boolean	equals (Object obj)
int	hashCode ()
boolean	isValid ()
	Validate this identifier. More...
String	toString ()

Private Attributes
final GlobalObjectDesignator	myHostGlobalObjDesignator
final String	myIdType
final short	myEmbeddedId

Additional Inherited Members
Protected Attributes inherited from com.mak.vrlj.object.GlobalObjectDesignator
String	myGlobalDesignator

Detailed Description

A tuple which uniquely identifies a embedded object.

Constructor & Destructor Documentation

com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier ( GlobalObjectDesignator  hostGod, short  embeddedId, String  idType  )

inline

Create an EmbeddedIdentifier.

Parameters

hostGod	a unique name for a simulation object instance.
embeddedId	a unique number identifying this specific object.
idType	specifies the type of the object

References com.mak.vrlj.object.EmbeddedIdentifier.myEmbeddedId, com.mak.vrlj.object.EmbeddedIdentifier.myHostGlobalObjDesignator, and com.mak.vrlj.object.EmbeddedIdentifier.myIdType.

com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier ( String  id )

inline

Create an EmbeddedIdentifier from a managed interface string.

Parameters

id	embedded identifier as a managed interface string

References com.mak.vrlj.object.GlobalObjectDesignator.GlobalObjectDesignator(), com.mak.vrlj.object.EmbeddedIdentifier.myEmbeddedId, com.mak.vrlj.object.EmbeddedIdentifier.myHostGlobalObjDesignator, and com.mak.vrlj.object.EmbeddedIdentifier.myIdType.

Member Function Documentation

short com.mak.vrlj.object.EmbeddedIdentifier.getEmbeddedId ( )

inline

Returns

which embedded system is identified.

References com.mak.vrlj.object.EmbeddedIdentifier.myEmbeddedId.

GlobalObjectDesignator com.mak.vrlj.object.EmbeddedIdentifier.getHost ( )

inline

Returns

References com.mak.vrlj.object.EmbeddedIdentifier.myHostGlobalObjDesignator.

Referenced by com.mak.vrlj.object.EmbeddedIdentifier.getHostEntityIdentifier().

EntityIdentifier com.mak.vrlj.object.EmbeddedIdentifier.getHostEntityIdentifier ( )

inline

Return the host ID as an EntityIdentifier if possible; otherwise, invalid ID.

Returns

References com.mak.vrlj.object.EmbeddedIdentifier.getHost(), and com.mak.vrlj.object.GlobalObjectDesignator.toString().

String com.mak.vrlj.object.EmbeddedIdentifier.getIdentifierType ( )

inline

Returns

References com.mak.vrlj.object.EmbeddedIdentifier.myIdType.

boolean com.mak.vrlj.object.EmbeddedIdentifier.isValid ( )

inlinevirtual

Validate this identifier.

Returns

true if this identifier is valid.

Implements com.mak.vrlj.object.ObjectIdentifier.

Member Data Documentation

final short com.mak.vrlj.object.EmbeddedIdentifier.myEmbeddedId

private

Referenced by com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier(), and com.mak.vrlj.object.EmbeddedIdentifier.getEmbeddedId().

final GlobalObjectDesignator com.mak.vrlj.object.EmbeddedIdentifier.myHostGlobalObjDesignator

private

Referenced by com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier(), and com.mak.vrlj.object.EmbeddedIdentifier.getHost().

final String com.mak.vrlj.object.EmbeddedIdentifier.myIdType

private

Referenced by com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier(), and com.mak.vrlj.object.EmbeddedIdentifier.getIdentifierType().

---

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

• EmbeddedIdentifier.java