The Robot Application Programming Interface Delegate Project
RAPID Logo

RapidImageSensorSample Class Reference

Inheritance diagram for RapidImageSensorSample:
Collaboration diagram for RapidImageSensorSample:

List of all members.

Public Member Functions

 RapidImageSensorSample ()
 RapidImageSensorSample (ImageSensorSample other)
void addExtraSequenceKeyTypeValue (KeyTypeValueTriple keyValue)
void addExtraSequenceKeyTypeValue (String key, DataType type, String value)
void setHeader (String srcName, String partitionName, long timeStamp, int statusCode)
 explicitly set each field of header
void setHeader (Agent srcAgent, String partitionName, long timeStamp, int statusCode)
 set header using Agent enums
void setHeader (Agent srcAgent, String partitionName, int statusCode)
 Initialize header with source, destination, and status code.
void updateHeader (int statusCode)
 update an existing header with statusCode and current timestamp
Header getHeader ()
String[] getAvailableExtraAttributeNames ()
NamedFloatRangeValue getRangeValue (String rangeSetting)
String[] getAvailableRangeSettingsNames ()
 returns the key names for stored range settings
NamedOptionSetValue getOptionSetValue (String rangeSetting)
String[] getAvailableOptionSettingNames ()
void addOptionSettingsValue (NamedOptionSetValue v)
void addOptionSettingValue (String name, OptionSetValue value)
void addOptionSettingsValue (String name, String option)
void addRangeSettingValue (NamedFloatRangeValue v)
void setImageData (byte[] byteData)
byte[] getImageDataArray (byte[] byteData)
void setImageHeight (int height)
void setImageWidth (int width)
void setImageMIMEType (String value)
String[] getExtraSequenceKeys ()
DataType getExtraSequenceDataType (String key)
void initializeVariables ()
 ensure that there is no way to send over a null through the wire
ImageMetadata getMetadata ()
Copyable getCopyable ()
String toString ()
void populateTopLevelAttributes ()
 MAE-4255: create top level access variables to simplify access.
KeyTypeValueTriple getExtraParameter (String key)
Boolean getBooleanParameter (String key) throws IncompatibleKeyTypeException
Double getDoubleParameter (String key) throws IncompatibleKeyTypeException
Float getFloatParameter (String key) throws IncompatibleKeyTypeException
Integer getIntegerParameter (String key) throws IncompatibleKeyTypeException
Object getParameterObject (String key)
String getStringParameter (String key) throws IncompatibleKeyTypeException

Public Attributes

ImageSensorSample imageSensorSample

Constructor & Destructor Documentation

Here is the call graph for this function:


Member Function Documentation

void addExtraSequenceKeyTypeValue ( KeyTypeValueTriple  keyValue)
void addExtraSequenceKeyTypeValue ( String  key,
DataType  type,
String  value 
)

Here is the call graph for this function:

void addOptionSettingsValue ( NamedOptionSetValue  v)
void addOptionSettingsValue ( String  name,
String  option 
)

Here is the call graph for this function:

void addOptionSettingValue ( String  name,
OptionSetValue  value 
)

Here is the call graph for this function:

void addRangeSettingValue ( NamedFloatRangeValue  v)
String [] getAvailableExtraAttributeNames ( )
Deprecated:
Use getAvailableOptionSettingNames().

Here is the call graph for this function:

String [] getAvailableOptionSettingNames ( )
String [] getAvailableRangeSettingsNames ( )
Returns:
String[]
Boolean getBooleanParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Copyable getCopyable ( )

Implements IRapidStruct.

Double getDoubleParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

KeyTypeValueTriple getExtraParameter ( String  key)
DataType getExtraSequenceDataType ( String  key)
String [] getExtraSequenceKeys ( )
Float getFloatParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

Header getHeader ( )
Returns:
hdr

Implements IRapidMessage.

byte [] getImageDataArray ( byte[]  byteData)
Integer getIntegerParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

ImageMetadata getMetadata ( )
NamedOptionSetValue getOptionSetValue ( String  rangeSetting)
Object getParameterObject ( String  key)

Here is the call graph for this function:

NamedFloatRangeValue getRangeValue ( String  rangeSetting)
String getStringParameter ( String  key) throws IncompatibleKeyTypeException

Here is the call graph for this function:

void initializeVariables ( )

Implements IRapidMessage.

void populateTopLevelAttributes ( )

Implements IRapidMessage.

void setHeader ( Agent  srcAgent,
String  partitionName,
int  statusCode 
)

Timestamp is filled in automatically.

Implements IRapidMessage.

Here is the call graph for this function:

void setHeader ( String  srcName,
String  partitionName,
long  timeStamp,
int  statusCode 
)
Parameters:
srcName
partitionName
timeStamp
statusCode
void setHeader ( Agent  srcAgent,
String  partitionName,
long  timeStamp,
int  statusCode 
)

Implements IRapidMessage.

Here is the call graph for this function:

void setImageData ( byte[]  byteData)
void setImageHeight ( int  height)
void setImageMIMEType ( String  value)
void setImageWidth ( int  width)
String toString ( )

Implements IRapidMessage.

Here is the call graph for this function:

void updateHeader ( int  statusCode)
Parameters:
statusCode

Implements IRapidMessage.

Here is the call graph for this function:


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines