cValue Class Reference¶

Type of the value stored in a cValue object.

Assignment

Returns the value type.

Returns the value type as string.

References getTypeName().

Referenced by getTypeName().

Returns the given type as a string.

Returns true if the stored value is of a numeric type.

Returns true if the value is not empty, i.e. type is not UNDEF.

Returns the value in text form.

Referenced by parseQuantity(), and parseQuantity().

Comparison. Note that two cValues are equal if they are of the same type (i.e. there is no implicit int <--> double conversion); if they contain object pointers, they are equal if they point to the same object.

Convert the given number into the target unit (e.g. milliwatt to watt). Throws an exception if conversion is not possible (unknown/unrelated units).

See also

convertTo(), doubleValueInUnit(), setUnit()

Invokes parseQuantity(), and converts the result into the given unit. If conversion is not possible (unrelated or unknown units), and error is thrown.

References str().

Converts a quantity given as string to a double, and returns it, together with the unit it was given in. If there are several numbers and units (see syntax), everything is converted into the last unit.

Syntax: <number> | (<number> <unit>)+

If there is a syntax error, or if unit mismatch is found (i.e. distance is given instead of time), the method throws an exception.

References str().

Returns the best unit for human consumption for the given quantity.

Formats the given quantity as a human-readable string. The output uses automatically selected regular or scientific notation, automatic unit conversion to the most readable unit, and digit grouping (e.g. thousands separator). The optional maxSignificantDigits argument limits the number of significant digits shown; values that are rounded are prefixed with a tilde (~). The default (15) shows the full double precision without approximation. The groupSeparator argument controls the thousands separator character(s); use "" to disable grouping.

Formats the given quantity as a human-readable string, after converting it to the best unit for human consumption. Equivalent to calling getBestUnit(), convertUnit(), and formatQuantity() in sequence. The groupSeparator argument controls the thousands separator character(s); use "" to disable grouping.

Sets the value to the given bool value.

Referenced by operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), operator=(), and operator=().

Sets the value to the given integer value and measurement unit (optional). The unit string pointer is expected to stay valid during the entire duration of the simulation (see related class comment).

Sets the value to the given integer value and measurement unit (optional). The unit string pointer is expected to stay valid during the entire duration of the simulation (see related class comment). This is a convenience method that delegates to the intval_t version.

References set().

Referenced by set().

Sets the value to the given double value and measurement unit (optional). The unit string pointer is expected to stay valid during the entire duration of the simulation (see related class comment).

Sets the value to the given integer value, preserving the current measurement unit. The object must already have the INT type.

Sets the value to the given double value, preserving the current measurement unit. The object must already have the DOUBLE type.

Sets the measurement unit to the given value, leaving the numeric part of the quantity unchanged. The object must already have the DOUBLE type. The unit string pointer is expected to stay valid during the entire duration of the simulation (see related class comment).

Permanently converts this value to the given unit. The value must already have the type DOUBLE. If the current unit cannot be converted to the given one, an error will be thrown. The unit string pointer is expected to stay valid during the entire simulation (see related class comment).

See also

doubleValueInUnit()

If this value is of type INT, converts it into DOUBLE; has no effect if it is already a DOUBLE; and throws an error otherwise.

Sets the value to the given string value. The string itself will be copied. nullptr is also accepted and treated as an empty string.

Sets the value to the given string value.

Sets the value to the given string value.

References opp_string::c_str().

Sets the value to the given pointer. The pointer is treated by as an opaque value: If it points to an object, the object's ownership is unaffected, and cValue will never delete or clone the object.

Sets the value to the given object, via set(any_ptr). Note that cValue solely stores the object's pointer, and does nothing extra. The object's ownership is unaffected, and cValue will never delete or clone the object.

References set().

Referenced by set().

Deleted function to prevent non-cObject pointers from silently being converted to bool.

Returns the value as a boolean. The type must be BOOL.

Referenced by operator bool().

Returns a dimensionless value as an integer. The type must be INT. This method cannot be used for values that have a unit (it will throw an exception); for those, use either intValueInUnit() or intValueRaw()+getUnit().

Referenced by operator char(), operator int(), operator long(), operator long long(), operator short(), operator unsigned char(), operator unsigned int(), operator unsigned long(), operator unsigned long long(), and operator unsigned short().

Returns value as an integer. The type must be INT. This method should be used together with getUnit() to be able to make sense of the returned value.

Returns the numeric value as an integer converted to the given unit. If the current unit cannot be converted to the given one, an error will be thrown. The type must be INT.

Returns a dimensionless value as a double. The type must be DOUBLE or INT. This method cannot be used for values that have a unit (it will throw an exception); for those, use either doubleValueInUnit() or doubleValueRaw()+getUnit().

Referenced by operator double(), and operator long double().

Returns the value as a double. The type must be DOUBLE or INT. This method should be used together with getUnit() to be able to make sense of the returned value.

Returns the numeric value as a double converted to the given unit. If the current unit cannot be converted to the given one, an error will be thrown. The type must be DOUBLE or INT.

Returns the unit ("s", "mW", "Hz", "bps", etc), or nullptr if there was no unit was specified. Unit is only valid for the DOUBLE and INT types.

Returns value as const char *. The type must be STRING.

Referenced by operator const char *().

Returns value as std::string. The type must be STRING.

Referenced by operator std::string().

Returns value as any_ptr. The type must be POINTER.

Referenced by operator any_ptr().

Returns true if the value is nullptr.

Returns true if the value contains a (non-null) pointer to a cObject.

Returns true if the value contains a (non-null) pointer to a cXMLElement.

Returns value as pointer to cObject. The type must be POINTER, and the pointer must point to an instance of cObject or be nullptr.

Referenced by operator cObject *().

Returns value as pointer to cXMLElement. The type must be POINTER, and the pointer must point to an instance of cXMLElement or be nullptr.

Referenced by operator cXMLElement *().

Equivalent to set(bool).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References set().

Equivalent to set(intval_t).

References set().

Converts the argument to long, and calls set(intval_t).

References omnetpp::checked_int_cast(), and set().

Equivalent to set(intval_t).

References omnetpp::checked_int_cast(), and set().

Converts the argument to long, and calls set(intval_t).

References omnetpp::checked_int_cast(), and set().

Equivalent to set(double).

References set().

Converts the argument to double, and calls set(double).

References set().

Equivalent to set(const char *).

References set().

Equivalent to set(const std::string&).

References set().

Equivalent to set(any_ptr).

References set().

Equivalent to set(cObject *).

References set().

Equivalent to boolValue().

References boolValue().

Calls intValue() and converts the result to char. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to unsigned char. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to int. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to unsigned int. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to short. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to unsigned short. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to long. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to unsigned long. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to long long. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Calls intValue() and converts the result to unsigned long long. An exception is thrown if the conversion would result in a data loss,

References omnetpp::checked_int_cast(), and intValue().

Equivalent to doubleValue().

References doubleValue().

Calls doubleValue() and converts the result to long double. Note that this is a potentially lossy operation.

References doubleValue().

Equivalent to stringValue().

References stringValue().

Equivalent to stdstringValue().

References stdstringValue().

Equivalent to pointerValue().

References pointerValue().

Equivalent to objectValue().

References objectValue().

Equivalent to xmlValue().

Note: The lifetime of the returned object tree is limited; see xmlValue() for details.

References xmlValue().