gov.nasa.arc.brahms.common.rt
Interface IConceptualInstanceCtx

All Superinterfaces:

IBrahmsObjectCtx, IConceptCtx

All Known Implementing Classes:

ConceptualInstanceCtx, VMConceptualInstanceCtx

public interface IConceptualInstanceCtx
extends IConceptCtx

The IConceptualInstanceCtx interface is the interface for the runtime representation of conceptual instances defined in a Brahms model. The conceptual instance context manages the creation and deletion time of the conceptual instances. The conceptual instance context also manages the list of sub aggregates or parts of the conceptual instance and the parent aggregates of the conceptual instance.

Version:

28 October 1999

Author:

Ron van Hoof

Method Summary

void	addAggregate(PartCtx aggregate) Adds the specified aggregate as an aggregate for this conceptual instance.
void	addSubAggregate(PartCtx subaggregate) Adds the specified sub aggregate as a sub aggregate for this conceptual instance.
java.util.Enumeration	getAggregates() Returns a list of all the aggregates (PartCtx).
java.util.Enumeration	getSubAggregates() Returns a list of all the sub aggregates (PartCtx).
void	removeAggregate(PartCtx aggregate) Removes the specified aggregate as an aggregate for this conceptual instance.
void	removeAllAggregates() Removes all the aggregates from the list of aggregates.
void	removeAllSubAggregates() Removes all the sub aggregates from the list of aggregates.
void	removeSubAggregate(PartCtx subaggregate) Removes the specified sub aggregate as a sub aggregate from this conceptual instance.

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IBrahmsObjectCtx

addNote, getContextFor, getEndTime, getID, getNote, getNotes, getStartTime, removeNote, setEndTime, setID, setStartTime

Method Detail

addAggregate

void addAggregate(PartCtx aggregate)
                  throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified aggregate as an aggregate for this conceptual instance. The actual aggregate is the part context's aggregate/parent. Aggregates and sub aggregates are associated through a PartCtx.

Parameters:

aggregate - the aggregate (PartCtx) to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if aggregate is null

removeAggregate

void removeAggregate(PartCtx aggregate)
                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified aggregate as an aggregate for this conceptual instance. The actual aggregate is the part context's aggregate/parent. Aggregates and sub aggregates are associated through a PartCtx.

Parameters:

aggregate - the aggregate to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if aggregate is null, no aggregates are available, or the aggregate is not found

getAggregates

java.util.Enumeration getAggregates()
                                    throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the aggregates (PartCtx).

Returns:

Enumeration an enumeration of PartCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no aggregates

removeAllAggregates

void removeAllAggregates()

Removes all the aggregates from the list of aggregates.

addSubAggregate

void addSubAggregate(PartCtx subaggregate)
                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified sub aggregate as a sub aggregate for this conceptual instance. The actual sub aggregate is the concept references by the part context. Aggregates and sub aggregates are associated through a PartCtx.

Parameters:

subaggregate - the sub aggregate (PartCtx) to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if sub aggregate is null

removeSubAggregate

void removeSubAggregate(PartCtx subaggregate)
                        throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified sub aggregate as a sub aggregate from this conceptual instance. The actual sub aggregate is the concept references by the part context. Aggregates and sub aggregates are associated through a PartCtx.

Parameters:

subaggregate - the aggregate to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if sub aggregate is null, no sub aggregates are available, or the sub aggregate is not found

getSubAggregates

java.util.Enumeration getSubAggregates()
                                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the sub aggregates (PartCtx).

Returns:

Enumeration an enumeration of PartCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no sub aggregates

removeAllSubAggregates

void removeAllSubAggregates()

Removes all the sub aggregates from the list of aggregates.