DbBlockPropertiesTable.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 _DbBlockPropertiesTable_h_Included_
#define _DbBlockPropertiesTable_h_Included_
 
#include "DbBlock1PtParameter.h"
#include "DbBlockGrips.h"
#include "DbParameterInterface.h"
#include "Int32Array.h" //FELIX_CHANGE

class DYNBLOCKS_EXPORT OdDbBlockUserParameter : public OdDbBlock1PtParameter
{
public:
  //DOM-IGNORE-BEGIN
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockUserParameter);
  //DOM-IGNORE-END

  OdDbBlockUserParameter();

  enum UserParameterType 
  {
    kDistance = 0,
    kArea = 1,
    kVolume = 2,
    kReal = 3,
    kAngle = 4,
    kString = 5
  };

  OdDbObjectId assocVarId() const;

  void setAssocVarId(OdDbObjectId id);

  OdString userVarName() const;
  //OdResult setUserVarName(const OdString&);
 
  /*
 
  virtual OdString expression()const;
  virtual void setExpression(const OdString&);
 
  virtual UserParameterType userParameterType()const;
  virtual void setUserParameterType(UserParameterType t);
 
  virtual OdString userVarDescription()const;
  virtual void setUserVarDescription(const OdString&);
 
 
  OdResult convertValue(OdResBuf*)const;
*/
  OdDbObjectId dependency() const;
  UserParameterType userParameterType() const; //FELIX_CHANGE
  OdDbObjectId GetVariableId() const; //FELIX_CHANGE
 
};

typedef OdSmartPtr<OdDbBlockUserParameter> OdDbBlockUserParameterPtr;

class OdDbBPTAuditError
{
public:
  enum BPTAuditErrorType {
    empty,
    noMatchingRow,
    invalidCell,
    notInValueSet,
    nonConstAttDef,
    invalidUnmatchedValue,
    duplicateRows,
    exprExternRef,
    cellEvalError
  };

  BPTAuditErrorType errorType() const { return m_Type; }

  void getCellIndex(int& row, int& col)const { row = m_nRow; col = m_nCol; }

  int getColumnIndex()const { return m_nCol; }

  OdIntArray getRowIndex() const { return m_Rows; }

  int getUnmatchedValueIndex()const { return m_nRow; }
protected:
  BPTAuditErrorType m_Type;
  int m_nRow;
  int m_nCol;
  OdIntArray m_Rows;
};

class DYNBLOCKS_EXPORT OdDbBlockPropertiesTable : public OdDbBlock1PtParameter
{
public:
  //DOM-IGNORE-BEGIN
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockPropertiesTable);
  //DOM-IGNORE-END

  OdDbBlockPropertiesTable();
  
  int numberOfColumns() const;
  
  int numberOfRows() const;
  
  OdResult getCellValue(int column, int row, OdResBufPtr &rb) const;

  OdResult setCellValue(int column, int row, const OdResBuf* rb);

  OdResult getCellValueString(int column, int row, OdString &s) const;
 
  // column flags
  bool constant(int column) const;

  OdResult setConstant(int column, bool val);

  bool editable(int column) const;

  OdResult setEditable(int column, bool val);
  
  bool removable(int column) const;

  OdResult setRemovable(int column, bool val);
  
  bool isAngular(int column) const;

  bool isAttribute(int) const;
 
  // column properties
  OdDbObjectId customProperties(int column) const;

  void setCustomProperties(int column, const OdDbObjectId& id);

  OdResBufPtr defaultValue(int column) const;

  void setDefaultValue(int column, const OdResBuf* rb);
  
  OdString format(int column) const;

  void setFormat(int column, const OdString& f);
 
  // if the values of the parameters must match some rows
  bool mustMatch() const;

  void setMustMatch(bool b);
 
  // what is used in the context menu if parameter values do not match anything
  void setUnmatchedValue(int column, const OdResBuf* rb);

  OdResBufPtr unmatchedValue(int column) const;

  OdString getColumnName(int column) const;
 
  //FELIX_CHANGE_BEGIN
  OdString GetName( OdInt32 iColumn ) const;
 
  OdInt32 GetColumnCount() const;
  OdInt32 GetRowCount() const;
  const OdInt32Array& GetRowIndices() const;
 
  const OdDbObjectId& GetParameterId( OdInt32 iColumn ) const;
  const OdResBufPtr GetValue( OdInt32 iColumn, OdInt32 iRow ) const;
  //FELIX_CHANGE_END
 
  const OdString GetConnectionAt( OdInt32 iColumn ) const; //FELIX_CHANGE_BEGIN - DESKTOP-313230
 
  // Table description (used as a property description)
  OdString tableDescription() const;

  void setTableDescription(const OdString& s);
 
  // Table name (used as a property name)
  OdString tableName() const;
  void setTableName(const OdString& s);
 
  // rows may be reordered, but each row has unique (within the table) id that will not change
  int idOfRow(int index) const;

  int indexOfRow(int id) const;

  void insertColumn(const OdDbObjectId& param, const OdString& connection, int after);

  void insertRow(int after);

  void removeColumn(int column);

  void removeRow(int row);

  void appendColumn(const OdDbObjectId& param, const OdString& connection);

  void appendRow();

  void moveColumn(int from, int to);

  void moveRow(int from, int to);
  
  static OdDbEvalNodeId bptNodeId(const OdDbEvalGraph* gr);
  virtual void addedToGraph(OdDbEvalGraph* ) override;
  virtual void erased(const OdDbObject* , bool) override;
  virtual void removedFromGraph(OdDbEvalGraph* gr) override;
  
  int getDefaultActiveRow() const;
  
  void setDefaultActiveRow(int row);
  
  bool columnValuesAreUnique(int col)const;
 
  // (not implemented, no idea what it does)
  bool disabledInDrawingEditor() const;
  
  // doesn't seem to have any effect besides the flag
  bool runtimeParametersOnly()const;

  void setRuntimeParametersOnly(bool b);
   
  void tableAudit(OdArray<OdDbBPTAuditError>&);
  
  void sortRows(int column, bool ascending);

  OdDbParameterInterfacePtr parameterInterface(int column, const OdDbBlockReference* block);

  int getCurrentRow() const;

  bool setCurrentRow(int row);
  
  OdDbObjectId getColumnParam(int column) const;
  
  bool isValid() const;
};

typedef OdSmartPtr<OdDbBlockPropertiesTable> OdDbBlockPropertiesTablePtr;

class DYNBLOCKS_EXPORT OdDbBlockPropertiesTableGrip : public OdDbBlockGrip
{
public:
  //DOM-IGNORE-BEGIN
  ODDB_DECLARE_MEMBERS(OdDbBlockPropertiesTableGrip);
  //DOM-IGNORE-END

  OdDbBlockPropertiesTableGrip();
};

typedef OdSmartPtr<OdDbBlockPropertiesTableGrip> OdDbBlockPropertiesTableGripPtr;
 
#endif //_DbBlockPropertiesTable_h_Included_