gov.nasa.arc.brahms.vm.api.common
Interface IObject
- All Superinterfaces:
- IActiveConcept, IActiveInstance, IConcept, IType, IUserDefinedType
public interface IObject
- extends IActiveInstance
An 'object' in Brahms is the second most central element in a Brahms
model. An object represents a specific artifact in the world. It is
possible to model the activities of an artifact in an organization.
For example the data processing activities of a computer system can
be modeled. The activities can be defined in the object's class
(which will be inherited by the object) and/or can be defined for
the object itself.
- See Also:
IActiveInstance
Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IActiveInstance |
assertBelief, assertBeliefs, getBelief, getBelief, getBelief, getBelief, getBelief, getBelief, getBelief, getBelief, getBeliefs, getBeliefs, getBeliefs, getBeliefs, getBeliefs, getBeliefs, getBeliefs, getBeliefs, getBeliefs, retractBelief |
Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IType |
getType |
isInstanceOf
boolean isInstanceOf(IClass cls)
throws ExternalException
- Determines whether this object is an instance of the specified class.
- Returns:
- true if this object is an instance of the specified class, false otherwise
- Throws:
ExternalException
- if cls is null
sendTo
void sendTo(IActiveInstance receiver,
int type,
IContext ctx)
throws ExternalException
- Sends this object and its contents to the specified receiver. If the
receiver is local to the object, i.e. both are active in the same
agent environment then the content of the object is transferred
without any additonal action, however if the receiver is hosted
in a different agent environment than then the object, then the
transfer type determines how the object is reconstructed in the
agent environment of the receiver. If the transfer type is
BY_REFERENCE then the object will remain a reference to this
object and the beliefs are transferred to the receiver. If however
the transfer type is BY_VALUE then the object will be converted
to a local copy of this object in the remote agent environment,
the beliefs are asserted in that copy and the beliefs are asserted
into the belief set of the receiver. Note that this action results
in two copies of the same object with the same unique identifier,
but belief updates in the belief set of this object in one agent
environment will not be reflected in the copies
of that object in other agent environments.
- Parameters:
receiver
- the ActiveInstance to receive the belief contents of this objecttype
- the transfer type BY_REFERENCE or BY_VALUEctx
- the IContext for the action
- Throws:
ExternalException
- ExternalException if an internal error occurs, in case of a
communication failure the linked exception will be one of
NotLocatableException, TransportFailure, or MessageNotRepliedToException- See Also:
ITransferType.BY_REFERENCE
,
ITransferType.BY_VALUE
,
javax.agent.service.transport.NotLocatableException
,
javax.agent.service.transport.TransportFailure
,
MessageNotRepliedToException
sendTo
void sendTo(IActiveInstance receiver,
int type,
IStatementOrganizer organizer,
IContext ctx)
throws ExternalException
- Sends this object and its contents to the specified receiver in the order
organized by the specified IStatementOrganizer. If the
receiver is local to the object, i.e. both are active in the same
agent environment then the content of the object is transferred
without any additonal action, however if the receiver is hosted
in a different agent environment than then the object, then the
transfer type determines how the object is reconstructed in the
agent environment of the receiver. If the transfer type is
BY_REFERENCE then the object will remain a reference to this
object and the beliefs are transferred to the receiver. If however
the transfer type is BY_VALUE then the object will be converted
to a local copy of this object in the remote agent environment,
the beliefs are asserted in that copy and the beliefs are asserted
into the belief set of the receiver. Note that this action results
in two copies of the same object with the same unique identifier,
but belief updates in the belief set of this object in one agent
environment will not be reflected in the copies
of that object in other agent environments.
- Parameters:
receiver
- the ActiveInstance to receive the belief contents of this objecttype
- the transfer type BY_REFERENCE or BY_VALUEorganizer
- the IStatementOrganizer used to send the object's beliefs in a
specific order organized by the organizerctx
- the IContext for the action
- Throws:
ExternalException
- ExternalException if an internal error occurs, in case of a
communication failure the linked exception will be one of
NotLocatableException, TransportFailure, or MessageNotRepliedToException- See Also:
ITransferType.BY_REFERENCE
,
ITransferType.BY_VALUE
,
javax.agent.service.transport.NotLocatableException
,
javax.agent.service.transport.TransportFailure
,
MessageNotRepliedToException