cartago
Interface IArtifactAdapter

All Known Implementing Classes:
AbstractArtifactAdapter

public interface IArtifactAdapter

Interface for artifact adapters

Author:
aricci

Method Summary
 void doOperation(cartago.OpExecutionFrame info)
          Request the execution of an operation
 Manual getManual()
          Get the artifact manual
 double getObservabilityRadius()
          return current artifact obs radius
 java.util.List<OpDescriptor> getOperations()
          Get the operations
 java.util.List<OperationInfo> getOpInExecution()
          Get current operation in execution
 AbstractWorkspacePoint getPosition()
          returns current artifact position
 boolean hasOperation(Op op)
          Check if the artifact has the specified operation
 void initArtifact(ArtifactConfig cfg)
          Init the artifact.
 void linkTo(ArtifactId aid, java.lang.String portName)
          Link to an artifact, specifying the out port
 java.util.List<ArtifactObsProperty> readProperties()
          Read all properties
 ArtifactObsProperty readProperty(java.lang.String propertyName)
          Read a property
 

Method Detail

initArtifact

void initArtifact(ArtifactConfig cfg)
                  throws CartagoException
Init the artifact.

Parameters:
cfg - initial configuration.
Throws:
CartagoException

doOperation

void doOperation(cartago.OpExecutionFrame info)
                 throws CartagoException
Request the execution of an operation

Parameters:
info - information about the operation
Throws:
CartagoException

readProperty

ArtifactObsProperty readProperty(java.lang.String propertyName)
                                 throws CartagoException
Read a property

Parameters:
propertyName -
Returns:
Throws:
CartagoException

readProperties

java.util.List<ArtifactObsProperty> readProperties()
Read all properties

Returns:
Throws:
CartagoException

getManual

Manual getManual()
Get the artifact manual

Returns:

linkTo

void linkTo(ArtifactId aid,
            java.lang.String portName)
            throws CartagoException
Link to an artifact, specifying the out port

Parameters:
aid -
portName -
Throws:
CartagoException

getOperations

java.util.List<OpDescriptor> getOperations()
                                           throws CartagoException
Get the operations

Returns:
Throws:
CartagoException

getOpInExecution

java.util.List<OperationInfo> getOpInExecution()
                                               throws CartagoException
Get current operation in execution

Returns:
Throws:
CartagoException

hasOperation

boolean hasOperation(Op op)
Check if the artifact has the specified operation

Parameters:
op -
Returns:

getPosition

AbstractWorkspacePoint getPosition()
returns current artifact position

Returns:

getObservabilityRadius

double getObservabilityRadius()
return current artifact obs radius

Returns:


>DEIS - University of Bologna