#ifndef baciValue_H #define baciValue_H /******************************************************************* * ALMA - Atacama Large Millimiter Array * (c) European Southern Observatory, 2004 * *This library is free software; you can redistribute it and/or *modify it under the terms of the GNU Lesser General Public *License as published by the Free Software Foundation; either *version 2.1 of the License, or (at your option) any later version. * *This library is distributed in the hope that it will be useful, *but WITHOUT ANY WARRANTY; without even the implied warranty of *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *Lesser General Public License for more details. * *You should have received a copy of the GNU Lesser General Public *License along with this library; if not, write to the Free Software *Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * "@(#) $Id: baciValue.h,v 1.112 2012/10/09 14:22:58 bjeram Exp $" * * who when what * -------- ---------- ---------------------------------------------- * bjeram 2003/08/08 changed octet inlineData_m[8] to double inlineData_m[2] duo to having problem on Sun with alignment * bjeram 2003/02/11 added MUTATOR(string, ACE_CString) * bjeram 2002/12/19 added accesor mutator template functions (temporary!!!) * msekoran 2001/07/26 fixed string type * msekoran 2001/03/02 created */ /** * @file * Header file for BACI Values. */ #ifndef __cplusplus #error This is a C++ include file and cannot be used from plain C #endif #include #include #include #include namespace baci { /** * WhyNull return value definitions */ /// Value is not a null type value #define NOT_NULL_VALUE 0 /// A null type value #define VALUE_NULL 1 /// An uninitialized value #define VALUE_UNINITIALIZED 2 /// Value type not implemented by BACIValue #define VALUE_NONEXISTENT 3 /** * Generic data type used in BACI * Class BACIValue is a data type wrapper for all * BACI supported types. It provides several methods * needed by BACI (compare operators, abs. diff., etc.) * @author Matej Sekoranja, * Jozef Stefan Institute, Slovenia
*/ class baci_EXPORT BACIValue { public: /** * Enumeration of all supported data types. If it's not listed * here, it cannot be packed into a #BACIValue. *
*/ enum Type { /// No-value. Can also be used to imply special meaning. type_null=0, /// Not really a type. This is just a void pointer used to pass any user-defined /// structures as a BACI Action parameter. THIS COULD NOT BE USED AS BACI TYPE! type_pointer=1, /// A string. type_string=2, /// A IEEE 8-byte floating point number. type_double=3, /// 32-bit signed integer. type_long=4, /// A bit pattern. type_pattern=9, //5, /// Sequence of double-s. type_doubleSeq=6, /// Sequencs of long-s. type_longSeq=7, /// 64-bit signed integer. type_longLong=8, /// 64-bit unsigned integer. type_uLongLong=9, /// Sequence of string-s. type_stringSeq=10, /// A IEEE 4-byte floating point number. type_float=11, /// Sequence of float-s. type_floatSeq=12, /// 32-bit unsigned integer. type_uLong=13, /// Sequencs of uLong-s. type_uLongSeq=14, /// boolean. type_boolean=15, /// boolean. type_booleanSeq=16 }; /** * An 8-bit unsigned integer. *
*/ typedef unsigned char octet; /** * Array of strings initialized to contain what are essentially * the same values as the #Type enum. Values are: * "null","pointer","string","double","long", "pattern","doubleSeq", * "longSeq","longLong","uLongLong","longString","float","floatSeq", * "uLong","uLongSeq","boolean","booleanSeq" * Furthermore, this array can be indexed using the #Type enum. *
*/ static const ACE_CString typeName[]; /** * Array of strings initialized to contain what are essentially * the same values as the #Type enum. Values are: * "invalid","invalid","string","double","long","long", * "doubleSeq" (not supported by logging),"longSeq","longLong", * "uLongLong","longString","float","floatSeq","uLong","uLongSeq", * "boolean","booleanSeq" * Furthermore, this array can be indexed using the #Type enum. *
*/ static const ACE_CString archiveTypeName[]; /** * A global predefined null BACIValue. *
*/ static const BACIValue NullValue; // --Constructors-------------------------------------------------------- /** * Standard Contructor. The wrapped value will carry a Type::type_null value. *
*/ BACIValue(); /** * Constructor with initialized type. * By using this constructor, one can create a #BACIValue object with any * type, although the value is not directly settable. * @param type Type of the wrapped value. * @param bound bound (for varialble length types) *
*/ BACIValue(const Type type, const unsigned long bound); /** * Copy constructor: construct a value that will store the same data as the specified value. * @param value A pre-existing #BACIValue object *
*/ BACIValue(const BACIValue &value); /** Constructor BACIdouble * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIdouble &value); /** Constructor BACIfoat * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIfloat &value); /** Constructor BACIlong * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIlong &value); /** Constructor realType * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIuLong &value); /** Constructor BACIpattern * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ //TOBE deleted BACIValue(const BACIpattern &value); /** Constructor BACIlongLong * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIlongLong &value); /** Constructor realType * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIuLongLong &value); /** Constructor ACE_CString * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const ACE_CString &value); /** Constructor char* * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const char* value); /** Constructor realType * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIboolean &value); /** Constructor - Special case * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const void* &value); /** Constructor - pointer (Special case * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(void * value); /** Constructor BACIdoubleSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIdoubleSeq &value); /** Constructor BACIfloatSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIfloatSeq &value); /** Constructor BACIlongSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIlongSeq &value); /** Constructor BACIuLongSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIuLongSeq &value); /** Constructor BACIstringSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIstringSeq &value); /** * Constructor CORBA::Any. * Deprecated. Used to support CORBA enums. * It is used by test in baci module. */ BACIValue(const BACIpattern &value, const CORBA::Any& any); /** Constructor BACIbooleanSeq * @param value A constant reference to a value which will be this #BACIValue * object's underlying value. *
*/ BACIValue(const BACIbooleanSeq &value); /** * Resets value to non-initialized state(VALUE_UNINITIALIZED, type_null type). *
*/ void reset(); // --Operators----------------------------------------------------------- /** * Equality Operator *
*/ BACIValue& operator=(const BACIValue &value); /** * Check equals to Operator *
*/ bool operator==(const BACIValue &value) const; /** * Check less-than Operator *
*/ bool operator<(const BACIValue &value) const; /** * Check less-than or equal to Operator *
*/ bool operator<=(const BACIValue &value) const; /** * Check if absolute difference between values is less than delta value * @param value value * @param delta delta value * @return true if difference between this object's value and given value is less that delta value *
*/ bool lessThanDelta(const BACIValue &value, const BACIValue &delta) const; /** * Check if percentual difference between values is less than delta value * @param value value * @param delta percentual delta value * @return true if percentual difference between this object's value and given value is less that delta value *
*/ bool lessThanPercentDelta(const BACIValue &value, const BACIValue &delta) const; // --Methods------------------------------------------------------------- /** * Set the data type that this value will store. * Makes the value capable of storing data of type Type. If the type * currently being stored by the filed does not match Type, it is properly * disposed. After using this function, the user should not assume that * the data has been initialized, i.e. using accessor before a mutator is illegal. * Example: 
     *       BACIValue value;
     *       value.setType(BACIValue::type_string);
     *
*
*/ bool setType(Type type, unsigned long bound = 0); /** * Get value type * @return value type *
*/ Type getType() const { return type_m;} /** * Get value type * @return archive type of the value *
*/ const char * getArchiveType() const { return archiveTypeName[type_m].c_str(); } /** * Get value bound (for variable length data types; eg. strings) * @return value bound *
*/ unsigned long getBound() const { return ptr_m.bound; }; /** * Is value null value (not initialized) * @return true if is null, false otherwise *
*/ unsigned long isNull() const { return type_m==type_null; } /** * Return the reason why the value was set as null value. * @return A code explaining the reason why the value is set to null. * If NOT_NULL_VALUE is returned, the value is not null. * Otherwise, one of these can be expected: * VALUE_NULL - The value is null because it is meant to carry a null value. * VALUE_UNINITIALIZED - The value is null because it has not yet been initialized to another value. * VALUE_NONEXISTENT - The value does not exist (data type was not implemented). *
*/ unsigned long whyIsNull() const { return (type_m==type_null)?whyNull_m:NOT_NULL_VALUE; } /** * Check if value equals no change (e.g. for double 0.0, int 0) * @return if value equals no change *
*/ bool noDelta() const; /** * Destructor *
*/ ~BACIValue(); // ---------------------------------------------------------------------- /** * Given a pointer to a baci::BACIdouble, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_double *
*/ static Type mapType(BACIdouble *v=0){ ACE_UNUSED_ARG(v); return type_double; } /** * Given a pointer to a baci::BACIfloat, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_float *
*/ static Type mapType(BACIfloat *v=0){ ACE_UNUSED_ARG(v); return type_float; } /** * Given a pointer to a baci::BACIlong, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_long *
*/ static Type mapType(BACIlong *v=0){ ACE_UNUSED_ARG(v); return type_long; } /** * Given a pointer to a baci::BACIuLong, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_uLong *
*/ static Type mapType(BACIuLong *v=0){ ACE_UNUSED_ARG(v); return type_uLong; } /** * Given a pointer to a baci::BACIpattern, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_pattern *
*/ //TOBE deleted static Type mapType(BACIpattern *v=0){ ACE_UNUSED_ARG(v); return type_pattern; } /** * Given a pointer to a char*, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_string *
*/ static Type mapType(char* *v=0){ ACE_UNUSED_ARG(v); return type_string; } /** * Given a pointer to an ACE_CString, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_string *
*/ static Type mapType(ACE_CString *v=0){ ACE_UNUSED_ARG(v); return type_string; } /** * Given a pointer to a baci::BACIboolean, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_boolean *
*/ static Type mapType(BACIboolean *v=0){ ACE_UNUSED_ARG(v); return type_boolean; } /** * Given a pointer to a void*, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_pointer *
*/ static Type mapType(void* *v=0){ ACE_UNUSED_ARG(v); return type_pointer; } /** * Given a pointer to a baci::BACIdoubleSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_doubleSeq *
*/ static Type mapType(BACIdoubleSeq *v=0){ ACE_UNUSED_ARG(v); return type_doubleSeq; } /** * Given a pointer to a baci::BACIfloatSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_floatSeq *
*/ static Type mapType(BACIfloatSeq *v=0){ ACE_UNUSED_ARG(v); return type_floatSeq; } /** * Given a pointer to a baci::BACIlongSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_longSeq *
*/ static Type mapType(BACIlongSeq *v=0){ ACE_UNUSED_ARG(v); return type_longSeq; } /** * Given a pointer to a baci::BACIuLongSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_uLongSeq *
*/ static Type mapType(BACIuLongSeq *v=0){ ACE_UNUSED_ARG(v); return type_uLongSeq; } /** * Given a pointer to a baci::BACIlongLong, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_longLong *
*/ static Type mapType(BACIlongLong *v=0){ ACE_UNUSED_ARG(v); return type_longLong; } /** * Given a pointer to a baci::BACIuLongLong, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_uLongLong *
*/ static Type mapType(BACIuLongLong *v=0){ ACE_UNUSED_ARG(v); return type_uLongLong; } /** * Given a pointer to a baci::BACIstringSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_stringSeq *
*/ static Type mapType(BACIstringSeq *v=0){ ACE_UNUSED_ARG(v); return type_stringSeq; } /** * Given a pointer to a baci::BACIbooleanSeq, this static method returns a the #Type enumeration value. * @param v Pointer to a BACI data type * @return BACIValue::type_booleanSeq *
*/ static Type mapType(BACIbooleanSeq *v=0){ ACE_UNUSED_ARG(v); return type_booleanSeq; } // ------------------------------------------------------------------ //accessors /** * Stringifies this object's underlying BACI value. * @return String value of this object or null if it's not a string. *
*/ const ACE_TCHAR* stringValue() const; /** * Given a pointer to an ACE C string, this method returns the stringified * value of this object. * @param v is an ACE_CString *. Invoker should just provide a null reference. * @return String value of this object *
*/ ACE_CString getValue(ACE_CString *v=0) const; /** * Given a const pointer to character pointers, this method returns the stringified * value of this object. * @param v is a constant char**. Invoker should just provide a null reference. * @return String value of this object *
*/ char* getValue(const char **v=0) const; /** * Given a pointer to character pointers, this method returns the stringified * value of this object. * @param v is a char**. Invoker should just provide a null reference. * @return String value of this object *
*/ char* getValue(char **v=0) const; /** * Returns this object's underlying BACI value as a double. * @return double value of this object or 0 if it's not a double. *
*/ BACIdouble doubleValue() const; /** * Returns this object's underlying BACI value as a double. * @param v is a BACIdouble *. Invoker should just provide a null reference. * @return double value of this object or 0 if it's not a double. *
*/ BACIdouble getValue(BACIdouble *v=0) const; /** * Returns this object's underlying BACI value as a long. * @return long value of this object or 0 if it's not a long. *
*/ /** * Returns this object's underlying BACI value as a double. * @return double value of this object or 0 if it's not a double. *
*/ BACIfloat floatValue() const; /** * Returns this object's underlying BACI value as a float. * @param v is a BACIfloat *. Invoker should just provide a null reference. * @return float value of this object or 0 if it's not a float. *
*/ BACIfloat getValue(BACIfloat *v=0) const; /** * Returns this object's underlying BACI value as a long. * @return long value of this object or 0 if it's not a long. *
*/ BACIlong longValue() const; /** * Returns this object's underlying BACI value as a long. * @param v is a BACIlong *. Invoker should just provide a null reference. * @return long value of this object or 0 if it's not a long. *
*/ BACIlong getValue(BACIlong *v=0) const; /** * Returns this object's underlying BACI value as an unsigned long. * @return unsigned long value of this object or 0 if it's not a unsigned long. *
*/ BACIuLong uLongValue() const; /** * Returns this object's underlying BACI value as an unsigned long. * @param v is a BACIuLong *. Invoker should just provide a null reference. * @return unsigned long value of this object or 0 if it's not a unsigned long. *
*/ BACIuLong getValue(BACIuLong *v=0) const; /** * Returns this object's underlying BACI value as a long long. * @return long long value of this object or 0 if it's not a long. *
*/ BACIlongLong longLongValue() const; /** * Returns this object's underlying BACI value as a long long. * @param v is a BACIlongLong *. Invoker should just provide a null reference. * @return long long value of this object or 0 if it's not a long. *
*/ BACIlongLong getValue(BACIlongLong *v=0) const; /** * Returns this object's underlying BACI value as an unsigned long long. * @return unsigned long long value of this object or 0 if it's not a unsigned long long. *
*/ BACIuLongLong uLongLongValue() const; /** * Returns this object's underlying BACI value as an unsigned long long. * @param v is a BACIuLongLong *. Invoker should just provide a null reference. * @return unsigned long long value of this object or 0 if it's not a unsigned long long. *
*/ BACIuLongLong getValue(BACIuLongLong *v=0) const; /** * Returns this object's underlying BACI value as a pattern. * @return pattern value of this object or 0 if it's not a pattern. *
*/ BACIpattern patternValue() const { return uLongLongValue(); } /** * Returns this object's underlying BACI value as an unsigned long. * @return unsigned long value of this object or 0 if it's not a unsigned long. *
*/ BACIboolean booleanValue() const; /** * Returns this object's underlying BACI value as an unsigned long. * @param v is a BACIboolean *. Invoker should just provide a null reference. * @return unsigned long value of this object or 0 if it's not a unsigned long. *
*/ BACIboolean getValue(BACIboolean *v=0) const; /** * Deprecated. * @return enum value of this object encoded into a CORBA any. *
*/ CORBA::Any enumValue() const; /** * Returns this object's underlying BACI value as a pattern. * @param v is a BACIpattern *. Invoker should just provide a null reference. * @return pattern value of this object or 0 if it's not a pattern. *
*/ //TOBE deleted BACIpattern getValue(BACIpattern *v=0) const; /** * Deprecated. * @param v is a CORBA::Any *. Invoker should just provide a null reference. * @return enum value of this object encoded into a CORBA any. *
*/ CORBA::Any getValue(CORBA::Any *v=0) const; /** * Returns this object's underlying BACI value as a void pointer. * @return void pointer value of this object or null if it's not a void pointer. *
*/ void* pointerValue() const; /** * Returns this object's underlying BACI value as a void pointer. * @param v is a void pointer *. Invoker should just provide a null reference. * @return void pointer value of this object or null if it's not a void pointer. *
*/ void* getValue(void* *v=0) const; /** * Returns this object's underlying BACI value as a double sequence. * @return double sequence of this object or 0 if it's not a double sequence. *
*/ BACIdoubleSeq doubleSeqValue() const; /** * Returns this object's underlying BACI value as a double sequence. * @param v is a BACIdoubleSeq *. Invoker should just provide a null reference. * @return double sequence of this object or 0 if it's not a double sequence. *
*/ BACIdoubleSeq getValue(BACIdoubleSeq *v=0) const; /** * Returns this object's underlying BACI value as a double sequence. * @return float sequence of this object or 0 if it's not a float sequence. *
*/ BACIfloatSeq floatSeqValue() const; /** * Returns this object's underlying BACI value as a float sequence. * @param v is a BACIfloatSeq *. Invoker should just provide a null reference. * @return float sequence of this object or 0 if it's not a float sequence. *
*/ BACIfloatSeq getValue(BACIfloatSeq *v=0) const; /** * Returns this object's underlying BACI value as a long sequence. * @return long sequence value of this object or 0 if it's not a long sequence. *
*/ BACIlongSeq longSeqValue() const; /** * Returns this object's underlying BACI value as a long sequence. * @param v is a BACIlongSeq *. Invoker should just provide a null reference. * @return long sequence value of this object or 0 if it's not a long sequence. *
*/ BACIlongSeq getValue(BACIlongSeq *v=0) const; /** * Returns this object's underlying BACI value as a unsigned long sequence. * @return unsigned long sequence value of this object or 0 if it's not an unsigned long sequence. *
*/ BACIuLongSeq uLongSeqValue() const; /** * Returns this object's underlying BACI value as an unsigned long sequence. * @param v is a BACIuLongSeq *. Invoker should just provide a null reference. * @return unsigned long sequence value of this object or 0 if it's not an unsigned long sequence. *
*/ BACIuLongSeq getValue(BACIuLongSeq *v=0) const; /** * Returns this object's underlying BACI value as a string sequence. * @return string sequence value of this object or 0 if it's not a not a string sequence. *
*/ BACIstringSeq stringSeqValue() const; /** * Returns this object's underlying BACI value as a string sequence. * @param v is a BACIstringSeq *. Invoker should just provide a null reference. * @return string sequence value of this object or 0 if it's not a not a string sequence. *
*/ BACIstringSeq getValue(BACIstringSeq *v=0) const; /** * Returns this object's underlying BACI value as a unsigned long sequence. * @return unsigned long sequence value of this object or 0 if it's not an unsigned long sequence. *
*/ BACIbooleanSeq booleanSeqValue() const; /** * Returns this object's underlying BACI value as an unsigned long sequence. * @param v is a BACIbooleanSeq *. Invoker should just provide a null reference. * @return unsigned long sequence value of this object or 0 if it's not an unsigned long sequence. *
*/ BACIbooleanSeq getValue(BACIbooleanSeq *v=0) const; // ------------------------------------------------------------------ /** * Mutator * @param value Reference to a BACIdouble that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool doubleValue(const BACIdouble &value); /** * Mutator * @param value Reference to a BACIdouble that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIdouble &value); /** * Mutator * @param value Reference to a BACIfloat that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool floatValue(const BACIfloat &value); /** * Mutator * @param value Reference to a BACIfloat that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIfloat &value); /** * Mutator * @param value Reference to a BACIlong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool longValue(const BACIlong &value); /** * Mutator * @param value Reference to a BACIlong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIlong &value); /** * Mutator * @param value Reference to a BACIuLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool uLongValue(const BACIuLong &value); /** * Mutator * @param value Reference to a BACIuLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIuLong &value); /** * Mutator * @param value Reference to a BACIlongLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool longLongValue(const BACIlongLong &value); /** * Mutator * @param value Reference to a BACIuLongLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIlongLong &value); /** * Mutator * @param value Reference to a BACIuLongLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool uLongLongValue(const BACIuLongLong &value); /** * Mutator * @param value Reference to a BACIuLongLong that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIuLongLong &value); /** * Mutator * @param value Reference to a BACIpattern that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool patternValue(const BACIpattern &value){ return setValue(value); } /** * Mutator * @param value Reference to a CORBA::Any that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ //?? bool enumValue(const int &value, const CORBA::Any &anyVal); bool enumValue(const BACIpattern &value, const CORBA::Any &anyVal); /** * Mutator * @param value Reference to a BACIpattern that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ //TOBE deleted bool setValue(const BACIpattern &value); /** * Deprecated mutator. * @param value Reference to a enum that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ //TOBE deleted bool setValue(const BACIpattern &value, const CORBA::Any &anyVal); /** * Mutator * @param value Reference to an ACE C string that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool stringValue(const ACE_CString &value); /** * Mutator * @param value Reference to an ACE C string that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const ACE_CString &value); /** * Mutator * @param value Reference to a character pointer that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool stringValue (const char * value); /** * Mutator * @param value Reference to a character pointer that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue (const char * value); /** * Mutator * @param value Reference to a BACIboolean that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool booleanValue(const BACIboolean &value); /** * Mutator * @param value Reference to a BACIboolean that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIboolean &value); /** * Mutator * @param value Reference to a void pointer that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool pointerValue (void * value); /** * Mutator * @param value Reference to a BACIdoubleSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool doubleSeqValue(const BACIdoubleSeq &value); /** * Mutator * @param value Reference to a BACIdoubleSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIdoubleSeq &value); /** * Mutator * @param value Reference to a BACIfloatSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool floatSeqValue(const BACIfloatSeq &value); /** * Mutator * @param value Reference to a BACIfloatSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIfloatSeq &value); /** * Mutator * @param value Reference to a BACIlongSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool longSeqValue(const BACIlongSeq &value); /** * Mutator * @param value Reference to a BACIlongSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIlongSeq &value); /** * Mutator * @param value Reference to a BACIuLongSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool uLongSeqValue(const BACIuLongSeq &value); /** * Mutator * @param value Reference to a BACIuLongSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIuLongSeq &value); /** * Mutator * @param value Reference to a BACIstringSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool stringSeqValue(const BACIstringSeq &value); /** * Mutator * @param value Reference to a BACIstringSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIstringSeq &value); /** * Mutator * @param value Reference to a BACIbooleanSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool booleanSeqValue(const BACIbooleanSeq &value); /** * Mutator * @param value Reference to a BACIbooleanSeq that this object will copy. * @return If the value currently contains other type of data than the one being * stored, the operation has no effect and false is returned. *
*/ bool setValue(const BACIbooleanSeq &value); // ------------------------------------------------------------------ //Conversion helpers /** * Convert to string * @param value where the string's value will be written to * @param bool if true (false is default) value type is also given (eg. 12.8), * which could help in decoding data value (as implemented in fromString method) * @return true on succes, false on failure * @see fromString *
*/ bool toString(ACE_CString &value, bool specifyType = false) const; /** * Convert from a string into a BACI type and encode it into this object. * @param value value represented as string * @param bool if true (false is default) value type is also given (eg. 12.8) * in input string, otherwise set type is used * @return true on succes, false on failure * @see toString *
*/ bool fromString(const ACE_CString value, bool specifyType = false); // ------------------------------------------------------------------ /** * Returns the BACIValue embedded within a CORBA any. Useful * with archiving. * @param Any reference in which we will store the underlying * BACIValue. */ void getAny(CORBA::Any &any) const; protected: /** * Identifies the type of data currently being stored. */ Type type_m; union { /** * Inlined data can be up to 8 bytes in length. This is sufficient for * storing octets, short, long, and longlong integers, doubles and * floats. *
*/ double inlineData_m[2]; /** * Other types store a pointer to the actual data and a bound * on the amount of data that can be stored there (e.g., number of * characters for strings). A bound of 0 indicates "no limits". *
*/ struct { unsigned long bound; void *pointer; } ptr_m; /** * Describes why the value has type null */ unsigned long whyNull_m; }; /** * This any is used as a hack to support enumeration properties. * Unless this BACIValue object is hiding an enumeration, do not * use this. */ CORBA::Any any_m; /** * This is set to true if the BACIValue is really an enumeration. */ bool isEnum_m; }; #include "baciValue.i" }; // ------------------[ Stream extraction ]----------------------- std::istream& operator>>(std::istream &is, ACE_CString &data); #endif /*! baciValue_H*/