RxMember.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 _ODRXMEMBER_INCLUDED_
#define _ODRXMEMBER_INCLUDED_
 
#include "OdString.h"
#include "OdArray.h"
#include "RxOverrule.h"
#include "SharedPtr.h"
 
//DOM-IGNORE-BEGIN
class OdRxValue;
class OdRxValueType;
class OdRxAttributeCollection;
class OdRxPromotingQueryContext;
 
class OdRxMemberIteratorImpl;
class OdRxMemberQueryContextImpl;
class OdRxMemberQueryEngineImpl;
class OdRxMemberImpl;
class OdRxMemberCollectionImpl;
 
class OdRxMember;
//DOM-IGNORE-END

typedef OdSmartPtr<OdRxMember> OdRxMemberPtr;

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

  const OdString& name() const throw();

  OdString localName() const throw();

  const OdRxValueType& type()const throw();

  const OdRxAttributeCollection& attributes() const throw();

  OdRxAttributeCollection& attributes() throw();

  const OdRxObject* owner() const throw();

  const OdArray<OdRxMemberPtr>* children() const throw();

  static void deleteMember(const OdRxMember* pMember) throw();
protected:
  friend class OdRxMemberImpl;
  virtual ~OdRxMember();
  OdRxMember(OdRxMemberImpl*);
  
  virtual OdString subLocalName() const;
  
  virtual OdResult subChildren(OdArray<OdRxMemberPtr>& children) const;

  virtual OdResult subChildrenEx(OdArray<OdRxMemberPtr>*& pChildren) const;

  void init(const OdString& name, const OdRxValueType* type, const OdRxObject* owner = 0);
  OdRxMemberImpl* m_pImpl;
};
 
//DOM-IGNORE-BEGIN
class OdRxEnumTag;
//DOM-IGNORE-END

typedef OdSmartPtr<OdRxEnumTag> OdRxEnumTagPtr;
//DOM-IGNORE-BEGIN
class OdRxEnumTagImpl;
//DOM-IGNORE-END

class FIRSTDLL_EXPORT OdRxEnumTag : public OdRxMember
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxEnumTag);
//DOM-IGNORE-END

  static OdRxEnumTagPtr createObject(const OdChar* name, const OdRxValue& value, const OdRxObject* owner);

  const OdRxValue& value() const;

  OdString alternateLocalName() const;
protected:
  OdRxEnumTag(OdRxMemberImpl*);
  virtual OdString subAlternateLocalName() const;
};

class ODRX_ABSTRACT FIRSTDLL_EXPORT OdRxMemberCollection
{
public:

  virtual ~OdRxMemberCollection();

  virtual int count() const = 0;

  virtual OdRxMember* getAt(int index) const = 0;
};

class FIRSTDLL_EXPORT OdRxMemberCollectionBuilder
{
public:

  void add(OdRxMember* member);

  const OdRxClass* owner() const { return m_owner; }
private:
  friend class OdRxMemberCollectionImpl;
  OdRxMemberCollectionBuilder(OdRxMemberCollectionImpl* imp, const OdRxClass* owner) : m_pImpl(imp), m_owner(owner) {}
  OdRxMemberCollectionImpl* m_pImpl;
  const OdRxClass* m_owner;
};

class FIRSTDLL_EXPORT OdRxMemberIterator
{
public:

  virtual ~OdRxMemberIterator();

  virtual bool done();

  virtual bool next();

  virtual OdRxMember* current() const;

  virtual OdRxMemberPtr find(const OdChar* name) const;
  
  virtual OdUInt64 size() const;
  
protected:
  OdRxMemberIterator();
private:
  friend class OdRxMemberIteratorImpl;
  OdRxMemberIteratorImpl* m_pImpl;
};

typedef OdSharedPtr<OdRxMemberIterator> OdRxMemberIteratorPtr;

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

  OdRxMemberIteratorPtr newMemberIterator(const OdArray<OdRxClassPtr>& facets) const;

  virtual OdRxMemberPtr find(const OdArray<OdRxClassPtr>& facets, const OdChar* name) const;
protected:
  friend class OdRxMemberQueryContextImpl;
  OdRxMemberQueryContextImpl* m_pImpl;
  OdRxMemberQueryContext();
  virtual ~OdRxMemberQueryContext();
  virtual OdRxMemberIteratorPtr subNewMemberIterator(const OdArray<OdRxClassPtr>& facets) const = 0;
};

struct ODRX_ABSTRACT FIRSTDLL_EXPORT OdRxFacetProvider : OdRxObject
{
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxFacetProvider);
//DOM-IGNORE-END

  virtual void getFacets(const OdRxObject* pO, const OdRxMemberQueryContext* pContext, OdArray<OdRxClassPtr>& facets) = 0;
};

typedef OdSmartPtr<OdRxFacetProvider> OdRxFacetProviderPtr;

class FIRSTDLL_EXPORT OdRxMemberReactor
{
public:

  virtual ~OdRxMemberReactor() {}

  virtual void goodbye(const OdRxMember* ) {}
};
 

class FIRSTDLL_EXPORT OdRxMemberQueryEngine
{
public:

  static OdRxMemberQueryEngine* theEngine();

  OdRxMemberPtr find(const OdRxObject* pO, const OdChar* name, const OdRxMemberQueryContext* pContext = NULL, bool bQueryFacets = true) const;

  OdRxMemberIteratorPtr newMemberIterator(const OdRxObject* pO, const OdRxMemberQueryContext* pContext = NULL) const;

  const OdRxMemberQueryContext* defaultContext() const;

  const OdRxPromotingQueryContext* promotingContext() const;

  void addFacetProvider(OdRxFacetProvider* pProvider);

  void removeFacetProvider(OdRxFacetProvider* pProvider);

  void addReactor(OdRxMemberReactor* pReactor);

  void removeReactor(OdRxMemberReactor* pReactor);
private:
  friend class OdRxMemberQueryEngineImpl;
  OdRxMemberQueryEngineImpl* m_pImpl;
  OdRxMemberQueryEngine(OdRxMemberQueryEngineImpl*);
};
 

class FIRSTDLL_EXPORT OdRxMemberOverrule : public OdRxObject
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdRxMemberOverrule);
//DOM-IGNORE-END

  static OdResult addOverrule(OdRxMember* pOverruledSubject, OdRxMemberOverrule* pOverrule, bool bAddAtLast = false);

  static OdResult removeOverrule(OdRxMember* pOverruledSubject, OdRxMemberOverrule* pOverrule);
};
 
#endif