Package ptolemy.data

Interface BitwiseOperationToken

All Known Implementing Classes:

BooleanToken, ComplexToken, ConcreteScalarToken, DoubleToken, FixToken, FloatToken, IntToken, LongToken, PetiteToken, ScalarToken, ShortToken, SmoothToken, UnsignedByteToken, UnsizedFixToken

public interface BitwiseOperationToken

The operations that can be performed on tokens that have bitwise operations.

Since:

Ptolemy II 2.1

Version:

$Id$

Author:

Steve Neuendorffer

Pt.AcceptedRating:

Yellow (wbwu)

Pt.ProposedRating:

Green (neuendor)

Method Summary

Modifier and Type	Method	Description
BitwiseOperationToken	bitwiseAnd(Token rightArgument)	Returns a token representing the bitwise AND of this token and the given token.
BitwiseOperationToken	bitwiseNot()	Returns a token representing the bitwise NOT of this token.
BitwiseOperationToken	bitwiseOr(Token rightArgument)	Returns a token representing the bitwise OR of this token and the given token.
BitwiseOperationToken	bitwiseXor(Token rightArgument)	Returns a token representing the bitwise XOR of this token and the given token.

Method Detail

bitwiseAnd

BitwiseOperationToken bitwiseAnd(Token rightArgument)
                          throws IllegalActionException

Returns a token representing the bitwise AND of this token and the given token.

Parameters:

rightArgument - The token that is bitwise ANDed with this token.

Returns:

The bitwise AND.

Throws:

IllegalActionException - If the given token is not compatible for this operation, or the operation does not make sense for this type.

bitwiseNot

BitwiseOperationToken bitwiseNot()
                          throws IllegalActionException

Returns a token representing the bitwise NOT of this token.

Returns:

The bitwise NOT of this token.

Throws:

IllegalActionException - If the given token is not compatible for this operation, or the operation does not make sense for this type.

bitwiseOr

BitwiseOperationToken bitwiseOr(Token rightArgument)
                         throws IllegalActionException

Returns a token representing the bitwise OR of this token and the given token.

Parameters:

rightArgument - The token that is bitwise OR'd with this token.

Returns:

The bitwise OR.

Throws:

IllegalActionException - If the given token is not compatible for this operation, or the operation does not make sense for this type.

bitwiseXor

BitwiseOperationToken bitwiseXor(Token rightArgument)
                          throws IllegalActionException

Returns a token representing the bitwise XOR of this token and the given token.

Parameters:

rightArgument - The token that is bitwise XOR'd with this token.

Returns:

The bitwise XOR.

Throws:

IllegalActionException - If the given token is not compatible for this operation, or the operation does not make sense for this type.