org.npsnet.xrti.proxies
Class EconomicCountryProxy

java.lang.Object
  org.npsnet.xrti.utilities.ObjectInstanceProxy
      org.npsnet.xrti.proxies.HLAobjectRootProxy
          org.npsnet.xrti.proxies.CountryProxy
              org.npsnet.xrti.proxies.EconomicCountryProxy

All Implemented Interfaces:

Country, EconomicCountry, HLAobjectRoot

public class EconomicCountryProxy

extends CountryProxy

implements EconomicCountry

A country with an economy.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private java.util.Vector	EconomicCountryListeners Listeners for attributes associated with the EconomicCountry class.
private double	grossDomesticProduct The country's gross domestic product.
private AttributeHandle	grossDomesticProductHandle The handle of the grossDomesticProduct attribute.
private boolean	grossDomesticProductIsDirty Whether or not the grossDomesticProduct attribute has changed.
private boolean	grossDomesticProductIsValid Whether or not the grossDomesticProduct attribute has been set.

Fields inherited from class org.npsnet.xrti.proxies.CountryProxy

Fields inherited from class org.npsnet.xrti.proxies.HLAobjectRootProxy

Fields inherited from class org.npsnet.xrti.utilities.ObjectInstanceProxy

autoFlushDisabled, classHandle, deleted, instanceHandle, rtiAmbassador

Constructor Summary

protected	EconomicCountryProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle) Constructor for object instance proxies created to represent new locally owned objects.
protected	EconomicCountryProxy(RTIambassador pRTIAmbassador, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created to represent new locally owned objects.
protected	EconomicCountryProxy(RTIambassador pRTIAmbassador, ObjectInstanceHandle pInstanceHandle, ObjectClassHandle pClassHandle, java.lang.String pName) Constructor for object instance proxies created in response to discovered objects.

Method Summary

void	addEconomicCountryListener(EconomicCountryListener l) Adds a listener for attributes associated with the EconomicCountry class.
protected void	getAttributeValuesToFlush(AttributeHandleValueMap ahvm, boolean superFlush) Places the attribute values to flush into the specified map.
double	getGrossDomesticProduct() Returns the value of the grossDomesticProduct attribute.
private void	initializeAttributes() Initializes the attributes and their handles.
void	provideAttributeValueUpdate(AttributeHandleSet theAttributes, byte[] userSuppliedTag) Notifies the proxy that it should provide an update regarding a set of object attributes.
void	reflectAttributeValues(AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the proxy of changes to the state of an object instance.
void	removeEconomicCountryListener(EconomicCountryListener l) Removes a listener for attributes associated with the EconomicCountry class.
void	setGrossDomesticProduct(double pGrossDomesticProduct, byte[] userSuppliedTag) Sets the value of the grossDomesticProduct attribute.

Methods inherited from class org.npsnet.xrti.proxies.CountryProxy

addCountryListener, getName, getPopulation, removeCountryListener, setName, setPopulation

Methods inherited from class org.npsnet.xrti.proxies.HLAobjectRootProxy

addHLAobjectRootListener, removeHLAobjectRootListener

Methods inherited from class org.npsnet.xrti.utilities.ObjectInstanceProxy

delete, equals, flushAttributeValues, flushAttributeValues, getAutoFlushDisabled, getClassHandle, getInstanceHandle, hashCode, isDeleted, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, setAutoFlushDisabled, setDeleted, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.npsnet.xrti.proxies.Country

addCountryListener, getName, getPopulation, removeCountryListener, setName, setPopulation

Methods inherited from interface org.npsnet.xrti.proxies.HLAobjectRoot

addHLAobjectRootListener, removeHLAobjectRootListener

Field Detail

EconomicCountryListeners

private java.util.Vector EconomicCountryListeners

Listeners for attributes associated with the EconomicCountry class.

grossDomesticProductHandle

private AttributeHandle grossDomesticProductHandle

The handle of the grossDomesticProduct attribute.

grossDomesticProductIsValid

private boolean grossDomesticProductIsValid

Whether or not the grossDomesticProduct attribute has been set.

grossDomesticProductIsDirty

private boolean grossDomesticProductIsDirty

Whether or not the grossDomesticProduct attribute has changed.

grossDomesticProduct

private double grossDomesticProduct

The country's gross domestic product.

Constructor Detail

EconomicCountryProxy

protected EconomicCountryProxy(RTIambassador pRTIAmbassador,
                               ObjectInstanceHandle pInstanceHandle,
                               ObjectClassHandle pClassHandle,
                               java.lang.String pName)
                        throws RTIinternalError

Constructor for object instance proxies created in response to discovered objects.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pInstanceHandle - the object instance handle

pClassHandle - the object class handle

pName - the object name

Throws:

RTIinternalError - if an internal error occurred in the run-time infrastructure

EconomicCountryProxy

protected EconomicCountryProxy(RTIambassador pRTIAmbassador,
                               ObjectClassHandle pClassHandle)
                        throws ObjectClassNotDefined,
                               ObjectClassNotPublished,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Constructor for object instance proxies created to represent new locally owned objects. Automatically notifies the run-time infrastructure.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pClassHandle - the object class handle

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

EconomicCountryProxy

protected EconomicCountryProxy(RTIambassador pRTIAmbassador,
                               ObjectClassHandle pClassHandle,
                               java.lang.String pName)
                        throws ObjectClassNotDefined,
                               ObjectClassNotPublished,
                               IllegalName,
                               ObjectInstanceNameInUse,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Constructor for object instance proxies created to represent new locally owned objects. Automatically notifies the run-time infrastructure.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

pClassHandle - the object class handle

pName - the object name

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

IllegalName - if the instance name has is illegal

ObjectInstanceNameInUse - if the instance name is already in use

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

Method Detail

initializeAttributes

private void initializeAttributes()
                           throws InvalidObjectClassHandle,
                                  NameNotFound,
                                  ObjectClassNotDefined,
                                  AttributeNotDefined,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Initializes the attributes and their handles.

Throws:

InvalidObjectClassHandle - if an object class handle is invalid

NameNotFound - if a name is not found

ObjectClassNotDefined - if an object class is not defined

AttributeNotDefined - if an attribute is not defined

FederateNotExecutionMember - if the federate is not an execution member

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

reflectAttributeValues

public void reflectAttributeValues(AttributeHandleValueMap theAttributes,
                                   byte[] userSuppliedTag,
                                   OrderType sentOrdering,
                                   TransportationType theTransport)
                            throws AttributeNotRecognized,
                                   AttributeNotSubscribed,
                                   FederateInternalError

Notifies the proxy of changes to the state of an object instance.

Overrides:

reflectAttributeValues in class CountryProxy

Parameters:

theAttributes - the map between attribute handles and the new values of the identified attributes

userSuppliedTag - a user-supplied tag associated with the state change

sentOrdering - the type of ordering with which the update was sent

theTransport - the type of transport associated with the update

Throws:

AttributeNotRecognized - if the attribute was not recognized

AttributeNotSubscribed - if the federate had not subscribed to the attribute

FederateInternalError - if an error occurs in the federate

provideAttributeValueUpdate

public void provideAttributeValueUpdate(AttributeHandleSet theAttributes,
                                        byte[] userSuppliedTag)
                                 throws AttributeNotRecognized,
                                        AttributeNotOwned,
                                        FederateInternalError

Notifies the proxy that it should provide an update regarding a set of object attributes.

Overrides:

provideAttributeValueUpdate in class CountryProxy

Parameters:

theAttributes - the set of attribute handles identifying the attributes that should be sent

userSuppliedTag - the user-supplied tag associated with the request

Throws:

AttributeNotRecognized - if an identified attribute was not recognized

AttributeNotOwned - if the federate did not own a specified attribute

FederateInternalError - if an error occurs in the federate

getAttributeValuesToFlush

protected void getAttributeValuesToFlush(AttributeHandleValueMap ahvm,
                                         boolean superFlush)
                                  throws RTIinternalError

Places the attribute values to flush into the specified map.

Overrides:

getAttributeValuesToFlush in class CountryProxy

Parameters:

ahvm - the attribute handle value map to populate

superFlush - if true provide updates for all attributes; if false, only provide updates for the modified ones

Throws:

RTIinternalError - if an internal error occurs in the run-time infrastructure

addEconomicCountryListener

public void addEconomicCountryListener(EconomicCountryListener l)

Adds a listener for attributes associated with the EconomicCountry class.

Specified by:

addEconomicCountryListener in interface EconomicCountry

Parameters:

l - the listener to remove

removeEconomicCountryListener

public void removeEconomicCountryListener(EconomicCountryListener l)

Removes a listener for attributes associated with the EconomicCountry class.

Specified by:

removeEconomicCountryListener in interface EconomicCountry

Parameters:

l - the listener to remove

setGrossDomesticProduct

public void setGrossDomesticProduct(double pGrossDomesticProduct,
                                    byte[] userSuppliedTag)
                             throws ObjectInstanceNotKnown,
                                    AttributeNotDefined,
                                    AttributeNotOwned,
                                    FederateNotExecutionMember,
                                    SaveInProgress,
                                    RestoreInProgress,
                                    RTIinternalError

Sets the value of the grossDomesticProduct attribute.

Specified by:

setGrossDomesticProduct in interface EconomicCountry

Parameters:

pGrossDomesticProduct - the new attribute value

userSuppliedTag - a user-supplied tag to associate with the action

Throws:

ObjectInstanceNotKnown - if the object instance is unknown

AttributeNotDefined - if one of the attributes is undefined

AttributeNotOwned - if one of the attributes is not owned

FederateNotExecutionMember - if the federate is not a member of an execution

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

getGrossDomesticProduct

public double getGrossDomesticProduct()

Returns the value of the grossDomesticProduct attribute.

Specified by:

getGrossDomesticProduct in interface EconomicCountry

Returns:

the current attribute value