VR-Link JAVA API Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
List of all members | Public Member Functions | Private Attributes
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 (EntityIdentifier id, short embeddedId, String idType)
 Create an EmbeddedIdentifier.
boolean equals (Object obj)
short getEmbeddedId ()
EntityIdentifier getEntityId ()
String getIdentifierType ()
int hashCode ()
boolean isValid ()
 Validate this identifier.
String toString ()

Private Attributes

final EntityIdentifier myEntityId
final String myIdType
final short myEmbeddedId

Detailed Description

A tuple which uniquely identifies a embedded object.

Constructor & Destructor Documentation

com.mak.vrlj.object.EmbeddedIdentifier.EmbeddedIdentifier ( EntityIdentifier  id,
short  embeddedId,
String  idType 
)
inline

Create an EmbeddedIdentifier.

Parameters
EntityIdentifiera unique name for a simulation object instance.
embeddedIda unique number identifying this specific object.

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

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

Member Function Documentation

boolean com.mak.vrlj.object.EmbeddedIdentifier.equals ( Object  obj)
inline
short com.mak.vrlj.object.EmbeddedIdentifier.getEmbeddedId ( )
inline
EntityIdentifier com.mak.vrlj.object.EmbeddedIdentifier.getEntityId ( )
inline
String com.mak.vrlj.object.EmbeddedIdentifier.getIdentifierType ( )
inline
int com.mak.vrlj.object.EmbeddedIdentifier.hashCode ( )
inline
boolean com.mak.vrlj.object.EmbeddedIdentifier.isValid ( )
inlinevirtual

Validate this identifier.

Returns
true if this identifier is valid.

Implements com.mak.vrlj.object.ObjectIdentifier.

String com.mak.vrlj.object.EmbeddedIdentifier.toString ( )
inline

Member Data Documentation

final short com.mak.vrlj.object.EmbeddedIdentifier.myEmbeddedId
private
final EntityIdentifier com.mak.vrlj.object.EmbeddedIdentifier.myEntityId
private
final String com.mak.vrlj.object.EmbeddedIdentifier.myIdType
private

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

Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)