vos/metaobjects/misc/metadata.hh

Go to the documentation of this file.

/* $Id: metadata.hh,v 1.14 2003/07/24 05:18:20 tetron Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>. 

   Search for TODO for stuff that needs editing. You will want to especially fill in constructors,
   destructors, message handlers, non-property subobjects...

   I can make no garuntee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file metadata.hh Defines MetaObject class for Metadata type (revision 0).

*/ 

#ifndef _METADATA_HH_
#define _METADATA_HH_

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef MISC_EXPORTS
#  define MISC_API __declspec(dllexport)
# else
#  define MISC_API __declspec(dllimport)
# endif
#else
# define MISC_API
#endif

/** MetaObject implementing Metadata Object Type. 
    
        A MetaObject which holds metadata for the rest of the object, such as author, creation and modification time, copyright, etc.
    
*/

class MISC_API Metadata : public virtual MetaObject
{
private:
    PropertyAccessControl* defaultPropertyAC;   // (passed to Property::setProperty, which ignores it if this object is remote)

public:

    /** Constructor */
    Metadata(MetaObject* superobject);

    /** Initialize subproperties, and set &NoPropertyAccessControl::static_ to
     * be the default property access control policy. */
    virtual void initialize() {
        initialize(&NoPropertyAccessControl::static_);
    }

    /** Initialize subproperties and set the default property access control
     * policy. */
    virtual void initialize(PropertyAccessControl* ac);
    

    /** Return type string ("misc:metadata") */
    const string getType();

    /** Register Extenders */
    static void registerExtenders();


    /** @name Access Subobjects */
    //@{

    /** Get the value of title property ( A title, shorter than the description. ). */
    string get_title();

    /** Get the datatype of title property. */
    string get_title_datatype();

    /** Set title property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_title(const string& value, const string& datatype = "?");

    /** Get the value of description property ( A description or abstract, longer than title. ). */
    string get_description();

    /** Get the datatype of description property. */
    string get_description_datatype();

    /** Set description property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_description(const string& value, const string& datatype = "?");

    /** Get the value of author property ( Name of the author.  ). */
    string get_author();

    /** Get the datatype of author property. */
    string get_author_datatype();

    /** Set author property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_author(const string& value, const string& datatype = "?");

    /** Get the value of author_url property ( URL to more information about the author.  ). */
    string get_author_url();

    /** Get the datatype of author_url property. */
    string get_author_url_datatype();

    /** Set author_url property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_author_url(const string& value, const string& datatype = "?");

    /** Get the value of creation_time property ( Time of creation (seconds since 00:00:00 UTC, 1970-01-01).  ). */
    string get_creation_time();

    /** Get the datatype of creation_time property. */
    string get_creation_time_datatype();

    /** Set creation_time property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_creation_time(const string& value, const string& datatype = "?");

    /** Get the value of modification_time property ( Time of last modification (seconds since 00:00:00 UTC, 1970-01-01).  ). */
    string get_modification_time();

    /** Get the datatype of modification_time property. */
    string get_modification_time_datatype();

    /** Set modification_time property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_modification_time(const string& value, const string& datatype = "?");

    /** Get the value of copyright property ( Copyright information.  ). */
    string get_copyright();

    /** Get the datatype of copyright property. */
    string get_copyright_datatype();

    /** Set copyright property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_copyright(const string& value, const string& datatype = "?");

    /** Get the value of version property ( Version number or identifer. ). */
    string get_version();

    /** Get the datatype of version property. */
    string get_version_datatype();

    /** Set version property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_version(const string& value, const string& datatype = "?");

    /** Get the value of language property ( Language of text, if applicable, in the format described by RFC 1766 (http://www.rfc-editor.org/rfc/rfc1766.txt), which is essentially ISO standard 639 with some extensions.  Language may also be given as a parameter to a text type identifier in a property typestring.). */
    string get_language();

    /** Get the datatype of language property. */
    string get_language_datatype();

    /** Set language property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_language(const string& value, const string& datatype = "?");

    /** Get the value of comment property ( Any comment.  ). */
    string get_comment();

    /** Get the datatype of comment property. */
    string get_comment_datatype();

    /** Set comment property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void set_comment(const string& value, const string& datatype = "?");

    //@}


};



/** Local version of Metadata. */

class MISC_API LocalMetadata : public virtual Metadata
{

public:

    /** Constructor */
    LocalMetadata(MetaObject* superobject);


    /** Static generator, for factory. */
    static MetaObject* new_LocalMetadata(MetaObject* superobject, const string& type);

    /** Called when this object gets a message */
    virtual void sendMessage(Message* m);
 
};


/** Remote version of Metadata. */

class MISC_API RemoteMetadata : public virtual Metadata
{

public:

    /** Constructor */
    RemoteMetadata(MetaObject* superobject);

    /** Static generator, for factory. */
    static MetaObject* new_RemoteMetadata(MetaObject* superobject, const string& type);

    /** Called when this object gets an update message from its Local master across the network. */
    void sendUpdateMessage(Message *m);

};


#endif // #ifdef _METADATA_HH_

---