import org.eclipse.linuxtools.ctf.core.event.io.BitBuffer;
/**
- * A CTF array definiton
+ * A CTF array definition
*
* Arrays are fixed-length. Their length is declared in the type
* declaration within the meta-data. They contain an array of "inner type"
import org.eclipse.linuxtools.ctf.core.event.io.BitBuffer;
/**
- * A CTF definiton
+ * A CTF definition
*
* A definition is like an object of a declaration class. It fills the declaration
* with values. <br>
}
/**
- * check if the label for a value (enum a{day=0,night=1} would return "day" for query(0)
+ * Check if the label for a value (enum a{day=0,night=1} would return "day" for query(0)
* @param value the value to lookup
* @return the label of that value, can be null
*/
}
/**
- * return the first label that matches a value
+ * Return the first label that matches a value
* @param value the value to query
* @return the label corresponding to that value
*/
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
private double value;
// ------------------------------------------------------------------------
- // Contructors
+ // Constructors
// ------------------------------------------------------------------------
/**
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
- * THe value of a float stored, fit into a double. This should be extended
+ * The value of a float stored, fit into a double. This should be extended
* for exotic floats if this is necessary.
*
* @return the value of the float field fit into a double.
// ------------------------------------------------------------------------
/**
- * Contructor
+ * Constructor
*
* @param len
* The length in bits
* @param base
* The base (10-16 are most common)
* @param byteOrder
- * Big endian little endian or other
+ * Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
}
/**
- * get the integer base commonly decimal or hex
+ * Get the integer base commonly decimal or hex
* @return the integer base
*/
public int getBase() {
}
/**
- * gets the byte order
+ * Gets the byte order
* @return the byte order
*/
public ByteOrder getByteOrder() {
}
/**
- * get encoding, chars are 8 bit ints
+ * Get encoding, chars are 8 bit ints
* @return the encoding
*/
public Encoding getEncoding() {
}
/**
- * is the integer a character (8 bits and encoded?)
+ * Is the integer a character (8 bits and encoded?)
* @return is the integer a char
*/
public boolean isCharacter() {
private long value;
// ------------------------------------------------------------------------
- // Contructors
+ // Constructors
// ------------------------------------------------------------------------
/**
}
// ------------------------------------------------------------------------
- // Gettters/Setters/Predicates
+ // Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
}
/**
- * gets the value in integer form
+ * Gets the value in integer form
*
* @return the integer in a Long, can be null
*/
}
/**
- * gets the value in string form
+ * Gets the value in string form
*
* @return the integer in a String, can be null
*/
/**
* A CTF string declaration.
- *
+ *
* Strings are an array of bytes of variable size and are terminated by a '\0'
* "NULL" character. Their encoding is described in the TSDL meta-data. In
* absence of encoding attribute information, the default encoding is UTF-8.
}
/**
- * generate an encoded string declaration
+ * Generate an encoded string declaration
* @param encoding the encoding, utf8 or ascii
*/
public StringDeclaration(Encoding encoding) {
}
/**
- * Lookup an array in a struct. if the name returns a non-array (like an
+ * Lookup an array in a struct. If the name returns a non-array (like an
* int) than the method returns null
*
* @param name
}
/**
- * Lookup an enum in a struct. if the name returns a non-enum (like an int)
+ * Lookup an enum in a struct. If the name returns a non-enum (like an int)
* than the method returns null
*
* @param name
}
/**
- * Lookup an integer in a struct. if the name returns a non-integer (like an
+ * Lookup an integer in a struct. If the name returns a non-integer (like an
* float) than the method returns null
*
* @param name
}
/**
- * Lookup a sequence in a struct. if the name returns a non-sequence (like
+ * Lookup a sequence in a struct. If the name returns a non-sequence (like
* an int) than the method returns null
*
* @param name
}
/**
- * Lookup a string in a struct. if the name returns a non-string (like
+ * Lookup a string in a struct. If the name returns a non-string (like
* an int) than the method returns null
*
* @param name
}
/**
- * Lookup a struct in a struct. if the name returns a non-struct (like
+ * Lookup a struct in a struct. If the name returns a non-struct (like
* an int) than the method returns null
*
* @param name
}
/**
- * Lookup a variant in a struct. if the name returns a non-variant (like
+ * Lookup a variant in a struct. If the name returns a non-variant (like
* an int) than the method returns null
*
* @param name
// ------------------------------------------------------------------------
/**
- * constructor
+ * Constructor
*/
public VariantDeclaration() {
-
}
// ------------------------------------------------------------------------
}
/**
- * gets current variant tag
+ * Gets current variant tag
* @return the variant tag.
*/
public String getTag() {
projects / deliverable / tracecompass.git / commitdiff
