Ignore:
Timestamp:
Feb 5, 2010, 9:08:33 AM (14 years ago)
Author:
Christoph Mayer
Message:

-missing doxygen in interface

File:
1 edited

Legend:

Unmodified
Added
Removed

  • source/ariba/DataMessage.h

    r7500 r7535  
    3333class DataMessage {
    3434private:
    35         void* data;
    36         size_t size;
     35        void* data; //< internal buffer pointer
     36        size_t size; //< internal buffer pointer size
    3737public:
    38         static const DataMessage UNSPECIFIED;
     38        static const DataMessage UNSPECIFIED; //< default implementation of a data message
    3939
     40        /**
     41         * Default constructor for a data message
     42         */
    4043        inline DataMessage() {
    4144                this->data = NULL;
    … …  
    4346        }
    4447
     48        /**
     49         * Constructor for a data message
     50         * @param data Data buffer to carry in the message
     51         * @param size Size of the buffer pointed to
     52         */
    4553        inline DataMessage( const void* data, const size_t size ) {
    4654                this->data = const_cast<void*>(data);
    … …  
    4856        }
    4957
     58        /**
     59         * Copy constructor for a data message
     60         * @param message The other message to copy from
     61         */
    5062        inline DataMessage(const DataMessage& message){
    5163                this->data = message.data;
    … …  
    5466
    5567#ifdef USE_MESSAGE_UTILITY
     68        /**
     69         * Construct a data message from a normal message
     70         * @param message The normal message to store
     71         */
    5672        inline DataMessage( const Message* message ) {
    5773                this->data = (void*)const_cast<Message*>(message);
    … …  
    5975        }
    6076
     77        /**
     78         * Construct a data message from a normal message
     79         * @param message The normal message to store
     80         */
    6181        inline DataMessage( const Message& message ) {
    6282                this->data = (void*)const_cast<Message*>(&message);
    … …  
    6484        }
    6585
     86        /**
     87         * Get the internal message when constructued through one
     88         * @return pointer to the message
     89         */
    6690        inline Message* getMessage() const {
    6791                if (isData()) {
    … …  
    7195        }
    7296
     97        /**
     98         * Conversion function to convert to Message*
     99         * @return internal message
     100         */
    73101        inline operator Message* () const {
    74102                return getMessage();
    … …  
    76104#endif
    77105
     106        /**
     107         * Is the data message a normal message?
     108         * @return true, if the data message is a normal message
     109         */
    78110        inline bool isMessage() const {
    79111                return size == ~(size_t)0;
    80112        }
    81113
     114        /**
     115         * Is the data message a data message
     116         * @return true, if the data message is not a normal message
     117         */
    82118        inline bool isData() const {
    83119                return !isMessage();
    84120        }
    85121
     122        /**
     123         * Directly access the internal data pointer
     124         * @return internal data pointer
     125         */
    86126        inline void* getData() const {
    87127                return data;
    88128        }
    89129
     130        /**
     131         * Get the size of the internal buffer
     132         * @return internal buffer size
     133         */
    90134        inline size_t getSize() const {
    91135                return size;
    92136        }
    93137
     138        /**
     139         * Is the data message invalid?
     140         * @return true, if data message is invalid
     141         */
    94142        inline bool isUnspecified() const {
    95143                return data == NULL;
    96144        }
     145
    97146};
    98147
Note: See TracChangeset for help on using the changeset viewer.