attach.hpp

Go to the documentation of this file.

// 
// BEGIN_DOUGLAS_MARK_ROYER_COPYRIGHT
//
// Copyright (C) 1993-2012 Douglas Mark Royer, All Rights Reserved.
// 
// NOTICE:
// 
// THIS SOURCE CODE BELONGS TO DOUGLAS MARK ROYER
// THIS CODE IS CONSIDERED A
// TRADE SECRET AND IS NOT TO BE DIVULGED OR USED BY PARTIES WHO HAVE
// NOT RECEIVED WRITTEN AUTHORIZATION FROM THE OWNER.
// 
// THIS SOFTWARE AND MANUAL ARE BOTH PROTECTED BY UNITED STATES
// COPYRIGHT LAW (TITLE 17 UNITED STATES CODE). UNAUTHORIZED REPRODUCTION
// AND/OR SALE MAY RESULT IN IMPRISONMENT OF UP TO ONE YEAR AND FINES
// OF UP TO $100,000 (17 USC 506). COPYRIGHT INFRINGERS MAY ALSO
// BE SUBJECT TO CIVIL LIABILITY.
// 
// THIS NOTICE AND THE ABOVE COPYRIGHT NOTICE MUST REMAIN IN ALL
// COPIES AND ANY DERIVED WORK.
// 
// ALL OF THIS CODE IS ORIGINAL WORK BY THE COPYRIGHT HOLDER.
// 
// THIS  DOCUMENT  AND  THE  INFORMATION  CONTAINED  HEREIN  IS
// PROVIDED  ON  AN "AS IS" BASIS AND INET-CONSULTING.COM, INC.
// DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,  INCLUDING  BUT
// NOT  LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
// HEREIN  WILL  NOT  INFRINGE  ANY  RIGHTS  OR   ANY   IMPLIED
// WARRANTIES  OF  MERCHANTABILITY  OR FITNESS FOR A PARTICULAR
// PURPOSE.  ANY SERVICE CONTRACT  WILL  BE  UNDER  A  SEPARATE
// LICENSE.
// 
// LICENSES ARE GRANTED TO:
//  INET-Consulting LLC a CALIFORNIA Corporation
//  INET-Consulting.com Inc a NEVADA Corporation
//  INET-Products.com a NEVADA Company
//
// END_DOUGLAS_MARK_ROYER_COPYRIGHT
//

/**
* @author Doug Royer / SoftwareAndServices
* @file
* This is a class and interfaces in C and C++ that represents calendar ATTACH
* data. It is designed to be compatible with RFC-iCalendar, RFC-iTIP, RFC-iMIP,
* CAP, and current WebDAV and CalDAV calendars. 
*/
#ifndef __DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_ATTACH_HPP__
#define __DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_ATTACH_HPP__

#ifndef EXPORT_ICALENDAR
#ifdef BUILDING_LIBRARY_ICALENDAR
#define EXPORT_ICALENDAR EXPORT_OUT
#else
#define EXPORT_ICALENDAR EXPORT_IN
#endif
#endif

#include <SaS/iCalendar/iCalendar.hpp>
#include <SaS/iCalendar/property.hpp>
#include <SaS/iCalendar/uri_property.hpp>
#include <SaS/iCalendar/uri.hpp>
#include <SaS/iCalendar/binary_property.hpp>
#include <SaS/iCalendar/binary.hpp>

using namespace std;
using namespace SoftwareAndServices::Library::Common;
using namespace SoftwareAndServices::Library::RfcBasic;
using namespace SoftwareAndServices::Library::iCalendar;

namespace SoftwareAndServices
{
    namespace Library 
    {
        namespace iCalendar
        {

            /**
             * @class attach
             * An RFC-iCalendar implementation of ATTACH property.
             */
            class EXPORT_ICALENDAR attach
                : public property
            {

            public:

                /**
                 * attach Constructor.
                 */
                attach();

                /**
                 * attach Constructor.
                 *
                 * @param Value The initial value.
                 */
                attach(const binary * Value);

                /**
                 * attach Constructor.
                 *
                 * @param Value The initial value.
                 */
                attach(const uri * Value);

                /**
                 * attach Destructor.
                 */
                virtual ~attach();

                /**
                 * @return TRUE if the attach values are correct.
                 */
                virtual bool            valid() const;

                /**
                 * #Parse a attach.
                 *
                 * @param in An open Parse object.
                 *
                 * @param errors Where any errors may be stored.
                 *
                 * @return TRUE when the parse is successful.
                 */
                virtual bool        parse(Parse & in, component * errors);

                /**
                 * #Parse a attach.
                 *
                 * @param in A pointer to a string containing a attach.
                 *
                 * @param errors Where any errors may be stored.
                 *
                 * @return TRUE when the parse is successful.
                 */
                bool            parse(const char * in, component * errors);

            };

            /**
             * @typedef attachVec
             * An array of attach.
             */
            typedef vector<attach*> attachVec;

        }
    }
}

#endif /*__DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_ATTACH_HPP__*/