idomjobtk.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef IDOMJOBTK_H
#define IDOMJOBTK_H
 
#include <edl/edltypes.h>
#include <edl/edlqname.h>
#include <edl/edlgeom.h>
#include <edl/idomnode.h>
#include <edl/idomresources.h>
#include <edl/iedlfactory.h>
#include <edl/edlvector.h>
 
_BEGIN_EDL_DOM_NAMESPACE
 
#define edlobj2IDOMJobTkNode(src) edl_cast((IDOMJobTkNode *)NULL, src)
class IDOMJobTkNode;
DECL_SMART_PTR(IDOMJobTkNode);
 
#define edlobj2IDOMJobTkValue(src) edl_cast((IDOMJobTkValue *)NULL, src)
class IDOMJobTkValue;
DECL_SMART_PTR(IDOMJobTkValue);
 
#define edlobj2IDOMJobTkContent(src) edl_cast((IDOMJobTkContent *)NULL, src)
class IDOMJobTkContent;
DECL_SMART_PTR(IDOMJobTkContent);
 
#define edlobj2IDOMJobTk(src) edl_cast((IDOMJobTk *)NULL, src)
class IDOMJobTk;
DECL_SMART_PTR(IDOMJobTk);
 
#define PSK_NAMESPACE "http://schemas.microsoft.com/windows/2003/08/printing/printschemakeywords"
#define PSF_NAMESPACE "http://schemas.microsoft.com/windows/2003/08/printing/printschemaframework"
#define XSD_NAMESPACE "http://www.w3.org/2001/XMLSchema"
#define XSI_NAMESPACE "http://www.w3.org/2001/XMLSchema-instance"
#define MAKO_NAMESPACE "http://schemas.globalgraphics.com/mako/2018"
#define EDL_PIPELINE_NAMESPACE "http://schemas.globalgraphics.com/edl/pipeline/2008"

typedef enum
{
    eDOMJobTkLevelNotValid  = 0,    
    eDOMJobTkLevelDefault   = 1,    
    eDOMJobTkLevelJob       = 2,    
    eDOMJobTkLevelDoc       = 3,    
    eDOMJobTkLevelPage      = 4,    
    eDOMJobTkLevelCnt       = 5,    
 
} eDOMJobTkLevel;

class IDOMJobTkOwner : public IDOMNode
{
#define IDOMJobTkOwnerClassID 0xc67ada74, 0x105b455c, 0xbacd2c3b, 0xa3381713
  public:

    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkOwnerClassID);
        return id;
    }

    virtual IDOMJobTkPtr getJobTicket() const = 0;

    virtual void setJobTicket(const IDOMJobTkPtr &ptrJobTicket) = 0;
 
};
 
DECL_SMART_PTR(IDOMJobTkOwner);
#define edlobj2IDOMJobTkOwner(src) edl_cast((IDOMJobTkOwner *)NULL, src)

class IDOMJobTkGenericNode : public IDOMNode
{
#define IDOMJobTkGenericNodeClassID 0xAF6FD278, 0xC7C848CA, 0xA85C88FD, 0xD2773FD5
  public:
    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkGenericNodeClassID);
        return id;
    }

    class Data : public CClassParams
    {
      public:
        EDLQName       name;
    };

    virtual EDLQName getQName() const = 0;

    virtual void addAttribute(const EDLQName &qname, const EDLSysString &value) = 0;

    virtual uint32 getNumAttributes() const = 0;

    virtual EDLSysString getAttributeAtIndex(uint32 index, EDLQName &qname) const = 0;
};
DECL_SMART_PTR(IDOMJobTkGenericNode);
#define edlobj2IDOMJobTkGenericNode(src) edl_cast((IDOMJobTkGenericNode *)NULL, src)

class IDOMJobTkGenericCharacterData : public IDOMNode
{
#define IDOMJobTkGenericCharacterDataClassID 0xA9A7CE3E, 0x0927418C, 0xBAFAA86C, 0xD49324DC
  public:
    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkGenericCharacterDataClassID);
        return id;
    }

    class Data : public CClassParams
    {
      public:
        EDLString  charData;
    };

    virtual EDLString getCharacterData() const = 0;

    virtual void setCharacterData(const EDLString &charData) = 0;

    virtual void appendCharacterData(const EDLString &charData) = 0;
};
DECL_SMART_PTR(IDOMJobTkGenericCharacterData);
#define edlobj2IDOMJobTkGenericCharacterData(src) edl_cast((IDOMJobTkGenericCharacterData *)NULL, src)

class IDOMJobTkNode : public IDOMNode
{
#define IDOMJobTkNodeClassID 0x2AE77EA2, 0x14E111DC, 0x83140800, 0x200C9A66
  public:

    typedef enum
    {
        eDOMJobTkNodeInValid,
        eDOMJobTkPTNodePrintTicket,
        eDOMJobTkPTNodePrintCapabilities,
        eDOMJobTkPTNodeParameterInit,
        eDOMJobTkPTNodeParameterRef,
        eDOMJobTkPTNodeParameterDef,
        eDOMJobTkPTNodeProperty,
        eDOMJobTkPTNodeFeature,
        eDOMJobTkPTNodeOption,
        eDOMJobTkPTNodeScoredProperty,
        eDOMJobTkPTNodeValue,
        eDOMJobTkPJLNodeName,
        eDOMJobTkPJLNodeValue
    } eDOMJobTkNodeType;

    class Data : public CClassParams
    {
      public:
        EDLQName           name;           
        eDOMJobTkNodeType  jobTkNodeType;  
    };

    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkNodeClassID);
        return id;
    }

    virtual void setQName(const EDLQName &qname)  = 0;

    virtual EDLQName getQName() const = 0;

    virtual EDLString getQNameAsString() const = 0;

    virtual void setJobTkNodeType(eDOMJobTkNodeType nodeType) = 0;

    virtual eDOMJobTkNodeType getJobTkNodeType() = 0;

    virtual IDOMJobTkContentPtr getJobTkContent() = 0;

    virtual IDOMJobTkValuePtr getChildValue() = 0;

    virtual IDOMJobTkNodePtr findChild(eDOMJobTkNodeType nodeType, const EDLString &name, const EDLSysString &nmspace) = 0;

    virtual IDOMJobTkNodePtr findChild(eDOMJobTkNodeType nodeType, const EDLQName &qname) = 0;
 
};
 

class IDOMJobTkValue : public IDOMNode
{
#define IDOMJobTkValueClassID 0x04EC0CCA, 0x151A11DC, 0x83140800, 0x200C9A66
  public:

    class Data : public CClassParams
    {
      public:
        PValue value;
    };

    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkValueClassID);
        return id;
    }

    virtual bool isValid() const = 0;

    virtual void setValue(const PValue &value) = 0;

    virtual PValue getValue() const = 0;
};
 

class IDOMJobTkContent : public IDOMNode
{
#define IDOMJobTkContentClassID 0xfde5a46a, 0xfd474247, 0x99d7957d, 0x9a185393
  public:

    class Data : public CClassParams
    {
      public:
        Data(): modified(false), level(eDOMJobTkLevelNotValid), version (0.0)
        {}
        eDOMJobTkLevel  level;      
        double         version;     
        bool           modified;    
    };

    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkContentClassID);
        return id;
    }

    virtual bool isValid() const = 0;

    virtual void setLevel(eDOMJobTkLevel level)  = 0;

    virtual eDOMJobTkLevel getLevel() const = 0;

    virtual void setVersion(double version)  = 0;

    virtual double getVersion() const = 0;

    virtual void setModified(bool modified)  = 0;

    virtual bool getModified() const = 0;

    virtual IDOMJobTkNodePtr getRootNode() = 0;

    virtual IEDLNamespaceCollectionEnumPtr getNamespaceCollectionEnum() = 0;

    virtual uint32 getNamespacesCount() = 0;

    virtual void clearNamespaceCollection() = 0;

    virtual void addNamespace(const IEDLNamespacePtr &ptrNamespace) = 0;

    virtual IEDLNamespacePtr addNamespace(const EDLSysString &prefix, const EDLSysString &name) = 0;

    virtual IEDLNamespacePtr findNamespaceByName(const EDLSysString &nmspace) = 0;

    virtual IEDLNamespacePtr findNamespaceByPrefix(const EDLSysString &prefix) = 0;

    virtual void addStandardNamespaces() = 0;

    virtual EDLQName convertToQName(const EDLString &name, const EDLSysString &nmspace) = 0;

    virtual IDOMJobTkNodePtr findChild(IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLString &name, const EDLSysString &nmspace) = 0;

    virtual IDOMJobTkNodePtr findChild(IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLQName &qname) = 0;

    virtual bool loadFromFile(const EDLSysString &filename) = 0;

    virtual bool loadFromStream(const IRAInputStreamPtr &xmlStream) = 0;

    virtual bool loadFromInitString(const EDLSysString & sInit) = 0;

    static EDL_API EDLSysString addToInitString(const EDLSysString &paramName, const EDLSysString &initString, const EDLSysString &paramValue = "", bool overwrite = true);

    virtual void addParameterInit(const IEDLNamespacePtr &parameterNamespace, const EDLSysString &parameterName, const PValue &value) = 0;

    virtual void addFeature(const IEDLNamespacePtr &featureNamespace, const EDLSysString &featureName, const EDLQName &option) = 0;
 
};
 

class IDOMJobTk : public IEDLObject
{
#define IDOMJobTkClassID 0x2AE77EA3, 0x14E111DC, 0x83140800, 0x200C9A66
  public:

    static const CClassID &classID()
    {
        static CClassID id(IDOMJobTkClassID);
        return id;
    }

    virtual void setOwner (IDOMJobTkOwnerPtr &ptrOwner) = 0;

    virtual IDOMJobTkOwnerPtr getOwner() const = 0;

    virtual void setContent (const IDOMJobTkContentPtr &ptrContent) = 0;

    virtual IDOMJobTkContentPtr getContent() const = 0;

    virtual IDOMJobTkNodePtr findChild(IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLString &name, const EDLSysString &nmspace) = 0;

    virtual IDOMJobTkNodePtr findChild(IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLQName &qname) = 0;

    virtual bool getCombinedContent(IDOMJobTkContentPtr &ptrCombinedContent, bool addDefaultJobTk = false) = 0;
};
 
EDL_API IDOMJobTkPtr getJobTicket(const IDOMNodePtr &ptrNode);
 

EDL_API IDOMJobTkPtr cloneJobTkTree(IDOMJobTkPtr &jobTk, IEDLClassFactory *factory);
 

EDL_API IDOMJobTkContentPtr cloneJobTkContentTree(IDOMJobTkContentPtr &jobTkContent, IEDLClassFactory *factory);
 
 
_END_EDL_DOM_NAMESPACE
 
#endif /* IDOMJOBTK_H */