///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, 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-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// This file is generated automatically.
#ifndef _IFC4X2_IFCPROJECTEDCRS_AUTO_IMPL_H
#define _IFC4X2_IFCPROJECTEDCRS_AUTO_IMPL_H
#include "IfcCoordinateReferenceSystemAutoImpl.h"
#include "IfcNamedUnitAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
IfcProjectedCRS is a coordinate reference system of the map to which the map translation of the local engineering coordinate system
of the construction or facility engineering project relates. The MapProjection and MapZone attributes uniquely identify the projection
to the underlying geographic coordinate reference system, provided that they are well-known in the receiving application.
The projected coordinate reference system is assumed to be a 2D or 3D right-handed Cartesian coordinate system,
the optional MapUnit attribute can be used determine the length unit used by the map.
The unambiguous identifier by which the coordinate reference system is known, is stored in the inherited Name attribute.
Well defined identifiers include the map projection and also the map zone information.
In these cases the MapProjection and the MapZone attributes can be omitted.
*/
class IFC4X2_EXPORT IfcProjectedCRS : public IfcCoordinateReferenceSystem
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcProjectedCRS);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of MapProjection attribute.
This attribute represents name by which the map projection is identified.
\returns
Returns the value of MapProjection attribute.
\remarks
EXAMPLE: map projects include:
* UTM
* Gaus-Krueger
*/
const OdAnsiString& getMapProjection() const;
/** \details
Sets the value of MapProjection attribute.
This attribute represents name by which the map projection is identified.
\param MapProjection [in] Map projection to set.
\remarks
EXAMPLE: map projects include:
* UTM
* Gaus-Krueger
*/
void setMapProjection(const OdAnsiString& MapProjection);
/** \details
Returns the value of MapZone attribute.
This attribute represents name by which the map zone, relating to the MapProjection, is identified.
\returns
Returns the value of MapZone attribute.
\remarks
EXAMPLE: for UTM, the zone number, like 32 for UTM32 for Gaus-Krueger, the zones of longitudinal width, like 3'
*/
const OdAnsiString& getMapZone() const;
/** \details
Sets the value of MapZone attribute.
This attribute represents name by which the map zone, relating to the MapProjection, is identified.
\param MapZone [in] Map zone to set.
\remarks
EXAMPLE: for UTM, the zone number, like 32 for UTM32 for Gaus-Krueger, the zones of longitudinal width, like 3'
*/
void setMapZone(const OdAnsiString& MapZone);
/** \details
Returns the value of MapUnit attribute.
This attribute represents unit of the coordinate axes composing the map coordinate system.
\returns
Returns the value of MapUnit attribute.
\remarks
Only length measures are in scope and all two or three axes of the map coordinate system have the same length unit.
If MapUnit is omitted, the unit for the coordinate axes is taken from the default units, as stated in IfcProject.UnitInContext.
*/
const OdDAIObjectId& getMapUnit() const;
/** \details
Sets the value of MapUnit attribute.
This attribute represents unit of the coordinate axes composing the map coordinate system.
\param MapUnit [in] Map unit to set.
\remarks
Only length measures are in scope and all two or three axes of the map coordinate system have the same length unit.
If MapUnit is omitted, the unit for the coordinate axes is taken from the default units, as stated in IfcProject.UnitInContext.
*/
void setMapUnit(const OdDAIObjectId& MapUnit);
public:
/** \details
Default constructor for the IfcProjectedCRS class.
*/
IfcProjectedCRS();
/** \details
Reads object's data from the specified filer.
\param rdFiler [in] Pointer to a filer from which to read the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;
/** \details
Writes object's data the the specified filer.
\param wrFiler [in] Pointer to a filer to which to write the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity type that determines an entity definition within a schema.
*/
virtual OdDAI::Entity* getInstanceType() const override;
/** \details
Returns an attribute value for the specified attribute name.
\param attrName [in] Name of an attribute to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const char * attrName) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrName [in] Explicit name of the attribute to reset.
*/
virtual void unsetAttr(const char * explicitAttrName) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrName [in] Explicit name of the attribute to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const char * explicitAttrName) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrName [in] Explicit name of the attribute to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;
/** \details
Checks whether the specified instance is the object derived from or belongs to this class.
\param entityType [in] Entity to check.
\returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.
*/
virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;
/** \details
Returns the type of this entity.
\returns
A value of the OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
/** \details
Returns an attribute value for the specified attribute definition.
\param attrDef [in] Attribute definition to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
*/
virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrDef [in] Attribute definition to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrDef [in] Explicit attribute definition to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;
protected:
// Fields declaration:
OdAnsiString m_MapProjection; // IfcIdentifier [optional]
OdAnsiString m_MapZone; // IfcIdentifier [optional]
OdDAIObjectId m_MapUnit; // IfcNamedUnit [optional]
};
/** \details
A data type that represents a smart pointer to a IfcProjectedCRS object.
*/
typedef OdSmartPtr IfcProjectedCRSPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCPROJECTEDCRS_AUTO_IMPL_H