TPTP 4.6.0 Platform Project
Public API Specification

org.eclipse.hyades.models.hierarchy
Interface TRCAgentProxy

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
TRCAgentProxyImpl

public interface TRCAgentProxy
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'TRC Agent Proxy'. A TRCAgent proxy, to enable support for loading and unloading the agent resource. This class shadows most of the properties of the TRCAgent: please check the documentation on TRCAgent for duplicated fields.

The following features are supported:

See Also:
HierarchyPackage.getTRCAgentProxy()
Generated
[EMF] Model

Method Summary
 TRCAgent getAgent()
          Returns the value of the 'Agent' reference.
 org.eclipse.emf.common.util.EList<TRCAnnotation> getAnnotations()
          Returns the value of the 'Annotations' containment reference list.
 TRCCollectionMode getCollectionMode()
          Returns the value of the 'Collection Mode' attribute.
 org.eclipse.emf.common.util.EList<TRCConfiguration> getConfigurations()
          Returns the value of the 'Configurations' containment reference list.
 double getDeltaTime()
          Returns the value of the 'Delta Time' attribute
 org.eclipse.emf.common.util.EList<TRCAgentProxy> getDerivedAgentProxies()
          Returns the value of the 'Derived Agent Proxies' reference list.
 org.eclipse.emf.common.util.EList<CorrelationContainerProxy> getInternalCorrelations()
          Returns the value of the 'Internal Correlations' reference list.
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 TRCProcessProxy getProcessProxy()
          Returns the value of the 'Process Proxy' container reference.
 java.lang.String getProfileFile()
          Returns the value of the 'Profile File' attribute
 org.eclipse.emf.common.util.EList<TRCAgentProxy> getRelatedAgentProxies()
          Returns the value of the 'Related Agent Proxies' reference list.
 java.lang.String getRuntimeId()
          Returns the value of the 'Runtime Id' attribute
 double getStartTime()
          Returns the value of the 'Start Time' attribute
 double getStopTime()
          Returns the value of the 'Stop Time' attribute
 java.lang.String getType()
          Returns the value of the 'Type' attribute.
 boolean isActive()
          Returns the value of the 'Active' attribute.
 boolean isAttached()
          Returns the value of the 'Attached' attribute.
 boolean isCollectionData()
          Returns the value of the 'Collection Data' attribute.
 boolean isMonitored()
          Returns the value of the 'Monitored' attribute.
 boolean isToProfileFile()
           
 void setActive(boolean value)
          Sets the value of the 'Active' attribute
 void setAgent(TRCAgent value)
          Sets the value of the 'Agent' reference
 void setAttached(boolean value)
          Sets the value of the 'Attached' attribute
 void setCollectionData(boolean value)
          Sets the value of the 'Collection Data' attribute
 void setCollectionMode(TRCCollectionMode value)
          Sets the value of the 'Collection Mode' attribute
 void setDeltaTime(double value)
          Sets the value of the 'Delta Time' attribute
 void setMonitored(boolean value)
          Sets the value of the 'Monitored' attribute
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setProcessProxy(TRCProcessProxy value)
          Sets the value of the 'Process Proxy' container reference
 void setProfileFile(java.lang.String value)
          Sets the value of the 'Profile File' attribute
 void setRuntimeId(java.lang.String value)
          Sets the value of the 'Runtime Id' attribute
 void setStartTime(double value)
          Sets the value of the 'Start Time' attribute
 void setStopTime(double value)
          Sets the value of the 'Stop Time' attribute
 void setType(java.lang.String value)
          Sets the value of the 'Type' attribute
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getName

java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), HierarchyPackage.getTRCAgentProxy_Name()
Generated
[EMF] Model

setName

void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()
Generated

getType

java.lang.String getType()
Returns the value of the 'Type' attribute. The default value is "_unknown".

If the meaning of the 'Type' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Type' attribute.
See Also:
setType(String), HierarchyPackage.getTRCAgentProxy_Type()
Generated
[EMF] Model
default="_unknown"

setType

void setType(java.lang.String value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
getType()
Generated

getRuntimeId

java.lang.String getRuntimeId()
Returns the value of the 'Runtime Id' attribute.

If the meaning of the 'Runtime Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Runtime Id' attribute.
See Also:
setRuntimeId(String), HierarchyPackage.getTRCAgentProxy_RuntimeId()
Generated
[EMF] Model

setRuntimeId

void setRuntimeId(java.lang.String value)
Sets the value of the 'Runtime Id' attribute.

Parameters:
value - the new value of the 'Runtime Id' attribute.
See Also:
getRuntimeId()
Generated

getStartTime

double getStartTime()
Returns the value of the 'Start Time' attribute.

If the meaning of the 'Start Time' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Start Time' attribute.
See Also:
setStartTime(double), HierarchyPackage.getTRCAgentProxy_StartTime()
Generated
[EMF] Model

setStartTime

void setStartTime(double value)
Sets the value of the 'Start Time' attribute.

Parameters:
value - the new value of the 'Start Time' attribute.
See Also:
getStartTime()
Generated

getStopTime

double getStopTime()
Returns the value of the 'Stop Time' attribute.

If the meaning of the 'Stop Time' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Stop Time' attribute.
See Also:
setStopTime(double), HierarchyPackage.getTRCAgentProxy_StopTime()
Generated
[EMF] Model

setStopTime

void setStopTime(double value)
Sets the value of the 'Stop Time' attribute.

Parameters:
value - the new value of the 'Stop Time' attribute.
See Also:
getStopTime()
Generated

getCollectionMode

TRCCollectionMode getCollectionMode()
Returns the value of the 'Collection Mode' attribute. The default value is "HEAP_STATISTICS_ONLY". The literals are from the enumeration TRCCollectionMode.

If the meaning of the 'Collection Mode' attribute isn't clear, there really should be more of a description here...

Defines different collection modes (some include filtering of data on agent side some on loader side and some are combined). This is used by loaders and UI to decide the model building algorithms and the presentation mode.

Returns:
the value of the 'Collection Mode' attribute.
See Also:
TRCCollectionMode, setCollectionMode(TRCCollectionMode), HierarchyPackage.getTRCAgentProxy_CollectionMode()
Generated
[EMF] Model
default="HEAP_STATISTICS_ONLY"

setCollectionMode

void setCollectionMode(TRCCollectionMode value)
Sets the value of the 'Collection Mode' attribute.

Parameters:
value - the new value of the 'Collection Mode' attribute.
See Also:
TRCCollectionMode, getCollectionMode()
Generated

isActive

boolean isActive()
Returns the value of the 'Active' attribute. The default value is "false".

If the meaning of the 'Active' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Active' attribute.
See Also:
setActive(boolean), HierarchyPackage.getTRCAgentProxy_Active()
Generated
[EMF] Model
default="false" transient="true"

setActive

void setActive(boolean value)
Sets the value of the 'Active' attribute.

Parameters:
value - the new value of the 'Active' attribute.
See Also:
isActive()
Generated

isAttached

boolean isAttached()
Returns the value of the 'Attached' attribute. The default value is "false".

If the meaning of the 'Attached' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Attached' attribute.
See Also:
setAttached(boolean), HierarchyPackage.getTRCAgentProxy_Attached()
Generated
[EMF] Model
default="false" transient="true"

setAttached

void setAttached(boolean value)
Sets the value of the 'Attached' attribute.

Parameters:
value - the new value of the 'Attached' attribute.
See Also:
isAttached()
Generated

isCollectionData

boolean isCollectionData()
Returns the value of the 'Collection Data' attribute. The default value is "false".

If the meaning of the 'Collection Data' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Collection Data' attribute.
See Also:
setCollectionData(boolean), HierarchyPackage.getTRCAgentProxy_CollectionData()
Generated
[EMF] Model
default="false" transient="true"

setCollectionData

void setCollectionData(boolean value)
Sets the value of the 'Collection Data' attribute.

Parameters:
value - the new value of the 'Collection Data' attribute.
See Also:
isCollectionData()
Generated

isMonitored

boolean isMonitored()
Returns the value of the 'Monitored' attribute. The default value is "false".

If the meaning of the 'Monitored' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Monitored' attribute.
See Also:
setMonitored(boolean), HierarchyPackage.getTRCAgentProxy_Monitored()
Generated
[EMF] Model
default="false" transient="true"

setMonitored

void setMonitored(boolean value)
Sets the value of the 'Monitored' attribute.

Parameters:
value - the new value of the 'Monitored' attribute.
See Also:
isMonitored()
Generated

getProfileFile

java.lang.String getProfileFile()
Returns the value of the 'Profile File' attribute.

If the meaning of the 'Profile File' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Profile File' attribute.
See Also:
setProfileFile(String), HierarchyPackage.getTRCAgentProxy_ProfileFile()
Generated
[EMF] Model
transient="true"

setProfileFile

void setProfileFile(java.lang.String value)
Sets the value of the 'Profile File' attribute.

Parameters:
value - the new value of the 'Profile File' attribute.
See Also:
getProfileFile()
Generated

getDeltaTime

double getDeltaTime()
Returns the value of the 'Delta Time' attribute. Used to synchronize entry, exit events between different agents, on a distributed application. It is in microseconds.

Returns:
the value of the 'Delta Time' attribute.
See Also:
setDeltaTime(double), HierarchyPackage.getTRCAgentProxy_DeltaTime()
Generated
[EMF] Model

setDeltaTime

void setDeltaTime(double value)
Sets the value of the 'Delta Time' attribute.

Parameters:
value - the new value of the 'Delta Time' attribute.
See Also:
getDeltaTime()
Generated

getAgent

TRCAgent getAgent()
Returns the value of the 'Agent' reference. It is bidirectional and its opposite is 'Agent Proxy'.

If the meaning of the 'Agent' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Agent' reference.
See Also:
setAgent(TRCAgent), HierarchyPackage.getTRCAgentProxy_Agent(), TRCAgent.getAgentProxy()
Generated
[EMF] Model
opposite="agentProxy"

setAgent

void setAgent(TRCAgent value)
Sets the value of the 'Agent' reference.

Parameters:
value - the new value of the 'Agent' reference.
See Also:
getAgent()
Generated

getInternalCorrelations

org.eclipse.emf.common.util.EList<CorrelationContainerProxy> getInternalCorrelations()
Returns the value of the 'Internal Correlations' reference list. The list contents are of type CorrelationContainerProxy.

If the meaning of the 'Internal Correlations' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Internal Correlations' reference list.
See Also:
HierarchyPackage.getTRCAgentProxy_InternalCorrelations()
Generated
[EMF] Model

getAnnotations

org.eclipse.emf.common.util.EList<TRCAnnotation> getAnnotations()
Returns the value of the 'Annotations' containment reference list. The list contents are of type TRCAnnotation.

If the meaning of the 'Annotations' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Annotations' containment reference list.
See Also:
HierarchyPackage.getTRCAgentProxy_Annotations()
Generated
[EMF] Model
containment="true"

getRelatedAgentProxies

org.eclipse.emf.common.util.EList<TRCAgentProxy> getRelatedAgentProxies()
Returns the value of the 'Related Agent Proxies' reference list. The list contents are of type TRCAgentProxy. It is bidirectional and its opposite is 'Derived Agent Proxies'.

If the meaning of the 'Related Agent Proxies' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Related Agent Proxies' reference list.
See Also:
HierarchyPackage.getTRCAgentProxy_RelatedAgentProxies(), getDerivedAgentProxies()
Generated
[EMF] Model
opposite="derivedAgentProxies"

getDerivedAgentProxies

org.eclipse.emf.common.util.EList<TRCAgentProxy> getDerivedAgentProxies()
Returns the value of the 'Derived Agent Proxies' reference list. The list contents are of type TRCAgentProxy. It is bidirectional and its opposite is 'Related Agent Proxies'.

If the meaning of the 'Derived Agent Proxies' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Derived Agent Proxies' reference list.
See Also:
HierarchyPackage.getTRCAgentProxy_DerivedAgentProxies(), getRelatedAgentProxies()
Generated
[EMF] Model
opposite="relatedAgentProxies"

getProcessProxy

TRCProcessProxy getProcessProxy()
Returns the value of the 'Process Proxy' container reference. It is bidirectional and its opposite is 'Agent Proxies'.

If the meaning of the 'Process Proxy' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Process Proxy' container reference.
See Also:
setProcessProxy(TRCProcessProxy), HierarchyPackage.getTRCAgentProxy_ProcessProxy(), TRCProcessProxy.getAgentProxies()
Generated
[EMF] Model
opposite="agentProxies"

setProcessProxy

void setProcessProxy(TRCProcessProxy value)
Sets the value of the 'Process Proxy' container reference.

Parameters:
value - the new value of the 'Process Proxy' container reference.
See Also:
getProcessProxy()
Generated

getConfigurations

org.eclipse.emf.common.util.EList<TRCConfiguration> getConfigurations()
Returns the value of the 'Configurations' containment reference list. The list contents are of type TRCConfiguration. It is bidirectional and its opposite is 'Agent Proxy'.

If the meaning of the 'Configurations' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Configurations' containment reference list.
See Also:
HierarchyPackage.getTRCAgentProxy_Configurations(), TRCConfiguration.getAgentProxy()
Generated
[EMF] Model
opposite="agentProxy" containment="true"

isToProfileFile

boolean isToProfileFile()

Generated
[EMF] Model
kind="operation"

TPTP 4.6.0 Platform Project
Public API Specification