TfObject.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __TF_OBJECT_H__
#define __TF_OBJECT_H__
 
#include "TD_PackPush.h"
 
#include "RxObject.h"
#include "RxIterator.h"
#include "TfVariant.h"
#include "DbStubPtrArray.h"
#include "Gi/GiDrawable.h"
 
//DOM-IGNORE-BEGIN
#define ODTF_CREATE_ATTRIBUTE(Name, value) \
  result.push_back(::newOdTfAttribute(OD_T(#Name), pObject, value));
 
#define ODTF_DEFINE_ATTRIBUTES_CONSTRUCTOR(Name, ATTRIBUTES_LIST) \
  static OdArray<OdTfAttribute*> Name##AttributesConstructor(     \
      OdRxObject* pObject) {                                      \
    OdArray<OdTfAttribute*> result;                               \
    ATTRIBUTES_LIST(ODTF_CREATE_ATTRIBUTE)                        \
    return result;                                                \
  }
 
#define ODTF_CREATE_PROPERTY_NO_ATTRS(PropertyName, type, getterFn, setterFn, \
                                      defaultItemFn)                           \
  result.push_back(::newOdTfProperty(                                          \
      OD_T(#PropertyName), pClass, static_cast<OdTfVariant::Type>(type), NULL, \
      defaultItemFn, getterFn, setterFn));
 
#define ODTF_DEFINE_PROPERTIES_CONSTRUCTOR(ClassName, PROPERTIES_LIST) \
  static OdArray<OdTfProperty*> ClassName##propertiesConstructor(      \
      OdTfClass* pClass) {                                             \
    OdArray<OdTfProperty*> result;                                     \
    PROPERTIES_LIST(ODTF_CREATE_PROPERTY_NO_ATTRS);                    \
    return result;                                                     \
  }
 
#define ODTF_DECLARE_MEMBERS(ClassName)\
    ODRX_DECLARE_MEMBERS_GENERIC(OdTfClass, ClassName)
 
#define ODTF_DEFINE_RTTI_MEMBERS(ClassName, ParentClass) \
  ODRX_DEFINE_RTTI_MEMBERS_GENERIC(OdTfClass, ClassName, ParentClass)
 
#define ODTF_DEFINE_INIT_MEMBERS(ClassName, ParentClass, attrsConsFn,      \
                                 propsConsFn, pseudoConsFn, szClassName)   \
  ODRX_DEFINE_INIT_MEMBERS_GENERIC(                                        \
      ClassName, (::newOdTfClass(szClassName, ParentClass::desc(),         \
                                 attrsConsFn, propsConsFn, pseudoConsFn)), \
      (::newOdTfClass(szClassName, ParentClass::desc(), attrsConsFn,       \
                      propsConsFn, pseudoConsFn)))
 
#define ODTF_DEFINE_MEMBERS2(ClassName, ParentClass, attrsConsFn, propsConsFn, \
                             pseudoConsFn, szClassName)                        \
                                                                               \
  ODTF_DEFINE_RTTI_MEMBERS(ClassName, ParentClass)                             \
  ODTF_DEFINE_INIT_MEMBERS(ClassName, ParentClass, attrsConsFn, propsConsFn,   \
                           pseudoConsFn, szClassName)
 
#define ODTF_NO_CONS_NO_ATTRS_NO_PROPS_DEFINE_MEMBERS(ClassName, ParentClass) \
                                                                              \
  ODTF_DEFINE_MEMBERS2(ClassName, ParentClass, NULL, NULL, NULL,              \
                       OD_T(#ClassName))                                      \
                                                                              \
  ODRX_DEFINE_PSEUDOCONSTRUCTOR(ClassName, EMPTY_CONSTR)
 
#define ODTF_NO_CONS_NO_ATTRS_PROPS_DEFINE_MEMBERS(ClassName, ParentClass, \
                                                   PROPERTIES_LIST)        \
  ODTF_DEFINE_PROPERTIES_CONSTRUCTOR(ClassName, PROPERTIES_LIST)           \
  ODTF_DEFINE_MEMBERS2(ClassName, ParentClass, NULL,                       \
                       ClassName##propertiesConstructor, NULL,             \
                       OD_T(#ClassName))                                   \
                                                                           \
  ODRX_DEFINE_PSEUDOCONSTRUCTOR(ClassName, EMPTY_CONSTR)
 
#define ODTF_CONS_NO_ATTRS_PROPS_DEFINE_MEMBERS(ClassName, ParentClass,    \
                                                PROPERTIES_LIST, DOCREATE) \
  ODTF_DEFINE_PROPERTIES_CONSTRUCTOR(ClassName, PROPERTIES_LIST)           \
  ODTF_DEFINE_MEMBERS2(ClassName, ParentClass, NULL,                       \
                       ClassName##propertiesConstructor,                   \
                       ClassName::pseudoConstructor, OD_T(#ClassName))     \
                                                                           \
  ODRX_DEFINE_PSEUDOCONSTRUCTOR(ClassName, DOCREATE)
 
#define ODTF_CONS_NO_ATTRS_NO_PROPS_DEFINE_MEMBERS(ClassName, ParentClass, \
                                                   DOCREATE)               \
  ODTF_DEFINE_MEMBERS2(ClassName, ParentClass, NULL, NULL,                 \
                       ClassName::pseudoConstructor, OD_T(#ClassName))     \
                                                                           \
  ODRX_DEFINE_PSEUDOCONSTRUCTOR(ClassName, DOCREATE)
 
//DOM-IGNORE-END
 
class OdTfObject;
class OdTfClass;
class OdTfProperty;
class OdTfAttribute;

class ODRX_ABSTRACT TFCORE_EXPORT OdTfAttributesContainer : public OdRxObject {
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTfAttributesContainer);
  //DOM-IGNORE-END
public:
  virtual OdRxObject* owner() const = 0;
  
  virtual const OdTfAttribute* find(const OdString& name) const = 0;
};

typedef OdSmartPtr<OdTfAttributesContainer> OdTfAttributesContainerPtr;

class ODRX_ABSTRACT TFCORE_EXPORT OdTfPropertiesContainer : public OdRxObject {
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTfPropertiesContainer);
  //DOM-IGNORE-END
public:

  typedef OdInt32 size_type;

  virtual OdTfClass* owner() const = 0;
  
  virtual size_type size() const = 0;
  
  virtual bool contains(const OdTfProperty* pProp) const = 0;
  
  virtual const OdTfProperty* find(size_type index) const = 0;
  
  virtual const OdTfProperty* find(const OdString& name) const = 0;
  
  virtual const OdTfProperty* find(const OdString& name,
                                   const OdTfVariant::Type type) const = 0;
                                   
  virtual size_type index(const OdTfProperty* pProp) const = 0;
  
  virtual bool unique(const OdString& name) const = 0;
  
  virtual bool unique(const OdString& name,
                      const OdTfVariant::Type type) const = 0;
                      
  virtual OdRxIteratorPtr iterator() const = 0;
};

typedef OdSmartPtr<OdTfPropertiesContainer> OdTfPropertiesContainerPtr;
 
class OdTfClassImpl;

class TFCORE_EXPORT OdTfClass : public OdRxClass {
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTfClass);
  //DOM-IGNORE-END
protected:
  OdTfClass(OdTfClassImpl*);
public:

  virtual const OdTfAttributesContainerPtr attributes() const;
  
  virtual const OdTfPropertiesContainerPtr properties() const;
  
  virtual const OdTfPropertiesContainerPtr allProperties() const;
  
  virtual OdTfClass* tfParent() const;
};

typedef OdSmartPtr<OdTfClass> OdTfClassPtr;

class ODRX_ABSTRACT TFCORE_EXPORT OdTfProperty : public OdRxObject {
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTfProperty);
  //DOM-IGNORE-END
public:

  virtual OdTfClass* owner() const = 0;
  
  virtual OdTfVariant::Type type() const = 0;
  
  virtual const OdString& name() const = 0;
  
  virtual OdTfAttributesContainerPtr attributes() const = 0;
  
  virtual OdTfVariant defaultItemValue() const = 0;
  
  virtual OdResult getValue(const OdTfObject* pObject,
                                     OdTfVariant& value) const = 0;

  virtual OdResult setValue(OdTfObject* pObject,
                                     const OdTfVariant& value) const = 0;
};

typedef OdSmartPtr<OdTfProperty> OdTfPropertyPtr;

class ODRX_ABSTRACT TFCORE_EXPORT OdTfAttribute : public OdRxObject {
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTfAttribute);
  //DOM-IGNORE-END
public:

  virtual OdRxObject* owner() const = 0;
  
  virtual const OdString& name() const = 0;
  
  virtual OdTfVariant value() const = 0;
};

typedef OdSmartPtr<OdTfAttribute> OdTfAttributePtr;

class TFCORE_EXPORT OdTfObject : public OdGiDrawable {
  //DOM-IGNORE-BEGIN
  ODTF_DECLARE_MEMBERS(OdTfObject);
  //DOM-IGNORE-END
 
public:

  typedef OdTfPropertiesContainer::size_type PropertyIndexType;
  
  typedef OdTfVariantArray::size_type ItemIndexType;

  virtual const OdTfObject* getOwner() const = 0;

  virtual OdResult getProperty(
      const OdTfProperty* pPI, OdTfVariant& value,
      const ItemIndexType arrayIndex = -1) const = 0;

  virtual OdResult setProperty(
      const OdTfProperty* pPI, const OdTfVariant& value,
      const ItemIndexType arrayIndex = -1) = 0;

  virtual OdResult getProperty(
      const OdString& name, OdTfVariant& value,
      const ItemIndexType arrayIndex = -1,
      const OdTfClass* pClass = NULL) const = 0;
      
  virtual OdResult setProperty(const OdString& name,
                                        const OdTfVariant& value,
                                        const ItemIndexType arrayIndex = -1,
                                        const OdTfClass* pClass = NULL) = 0;
  virtual OdResult getProperty(
      const PropertyIndexType propertyIndex, OdTfVariant& value,
      const ItemIndexType arrayIndex = -1) const = 0;
      
  virtual OdResult setProperty(
      const PropertyIndexType propertyIndex, const OdTfVariant& value,
      const ItemIndexType arrayIndex = -1) = 0;
};

typedef OdSmartPtr<OdTfObject> OdTfObjectPtr;
 
//
//
//

typedef OdArray<OdTfProperty*>(*OdTfPropertiesConstructorType)(OdTfClass*);

typedef OdArray<OdTfAttribute*>(*OdTfAttributesConstructorType)(OdRxObject*);

typedef OdResult (*OdTfPropertyGetterType)(const OdTfObject*,
                                                    OdTfVariant&);
                                                    
typedef OdResult (*OdTfPropertySetterType)(OdTfObject*,
                                                    const OdTfVariant&);
                                                    
typedef OdTfVariant (*OdTfVariantConstructorType)();

TFCORE_EXPORT OdTfClass* newOdTfClass(
    const OdString& name, OdRxClass* pBaseClass,
    OdTfAttributesConstructorType pAttrsConstr,
    OdTfPropertiesConstructorType pPropsConstr, OdPseudoConstructorType pConstr,
    bool bRegister = true);

TFCORE_EXPORT OdTfClass* createOdTfClass();

TFCORE_EXPORT OdTfClass* initOdTfClass(
    OdTfClass* pClass, const OdString& name, OdRxClass* pBaseClass,
    const OdArray<OdTfAttribute*>& attributes,
    const OdArray<OdTfProperty*>& properties, OdPseudoConstructorType pConstr,
    bool bRegister = true);

TFCORE_EXPORT OdTfProperty* newOdTfProperty(
    const OdString& name, OdTfClass* pOwner, OdTfVariant::Type type,
    OdTfAttributesConstructorType pAttrsConstr,
    OdTfVariantConstructorType pDefaultValueConstructor,
    OdTfPropertyGetterType pGetter, OdTfPropertySetterType pSetter);

TFCORE_EXPORT OdTfProperty* createOdTfProperty();

TFCORE_EXPORT OdTfProperty* initOdTfProperty(
    OdTfProperty* pProp, const OdString& name, OdTfClass* pOwner,
    OdTfVariant::Type type, const OdArray<OdTfAttribute*>& attributes,
    OdTfVariantConstructorType pDefaultValueConstructor,
    OdTfPropertyGetterType pGetter, OdTfPropertySetterType pSetter);

TFCORE_EXPORT OdTfAttribute* newOdTfAttribute(const OdString& name,
                                              OdRxObject* pOwner,
                                              const OdTfVariant& value);
#include "TD_PackPop.h"
#endif  // __TF_OBJECT_H__