IfcWorkCalendar Class

Syntax

C++

class IfcWorkCalendar : public IfcControl;

Description

An IfcWorkCalendar defines working and non-working time periods for tasks and resources. It enables to define both specific time periods, such as from 7:00 till 12:00 on 25th August 2009, as well as repetitive time periods based on frequently used recurrence patterns, such as each Monday from 7:00 till 12:00 between 1st March 2009 and 31st December 2009.

Details

A work calendar is a subtype of IfcControl and thus inherits the feature for controlling other objects through IfcRelAssignsToControl, which is used to define a work calendar for tasks (IfcTask) and resources (IfcResource). It also inherits a name and description attribute, whereas a name shall be given and a description may be given as an indication of its content and usage.

The figure below shows the definition of a work calendar, which is defined by a set of work times and exception times. The work times are defined as recurring patterns with optional boundaries (applying from and/or to a specific date). The shown example defines a simple work calendar with working times Monday to Thursday 8:00 to 12:00 and 13:00 to 17:00, Friday 8:00 to 14:00 and as exception every 1st Monday in a month the work starts one hour later - i.e. the working time on every 1st Monday in a month is overridden to be 9:00 to 12:00 and 13:00 to 17:00. Both the working time and the exception time is valid for the period of 01.09.2010 till 30.08.2011.

Control Assignment

The base calendar of a work calendar is defined by IfcRelAssignsToControl, where IfcRelAssignsToControl.RelatingControl is linked with the base calendar and IfcRelAssignsToControl.RelatedObjects is linked with work calendars that are derived from the base calendar. Although not restricted by the IfcRelAssignsToControl relationship it is only allowed to have one base calendar.

Class Hierarchy

File: IfcWorkCalendarAutoImpl.h

Namespace: OdIfc4x2

Methods

Show:Inherited

No members matching the current filter

ApplicationInstance	Creates a new application instance with default parameters. (Inherited from ApplicationInstance)
IfcControl	Default constructor for the IfcControl class. (Inherited from IfcControl)
IfcObject	Default constructor for the IfcObject class. (Inherited from IfcObject)
IfcRoot	Default constructor for the IfcRoot class. (Inherited from IfcRoot)
IfcWorkCalendar	Default constructor for the IfcWorkCalendar class.
OdIfcInstance	Creates a new IFC instance object with default parameters. (Inherited from OdIfcInstance)
~OdIfcInstance	Destroys the instance object. (Inherited from OdIfcInstance)

Methods

Show:Inherited

No members matching the current filter

asCompound	Returns the result of the instance resolution represented as a compound object. (Inherited from OdIfcInstance)
asMatrix2d	Returns the result of the instance resolution represented as a two-dimensional matrix. (Inherited from OdIfcInstance)
asMatrix3d	Returns the result of the instance resolution represented as a three-dimensional vector. (Inherited from OdIfcInstance)
asPoint2d	Returns the result of the instance resolution represented as a two-dimensional point. (Inherited from OdIfcInstance)
asPoint3d	Returns the result of the instance resolution represented as a three-dimensional point. (Inherited from OdIfcInstance)
asRgbColor	Returns the result of the instance resolution represented as an RGB color object. (Inherited from OdIfcInstance)
asVector2d	Returns the result of the instance resolution represented as a two-dimensional vector. (Inherited from OdIfcInstance)
asVector3d	Returns the result of the instance resolution represented as a three-dimensional vector. (Inherited from OdIfcInstance)
cleanDynamicAttributes	Cleans dynamic attributes. (Inherited from ApplicationInstance)
comparedTo	Compares the application instance object with another object. (Inherited from ApplicationInstance)
comparedToInverse	Compares the application instance object with another object by comparing their inverse attributes. (Inherited from ApplicationInstance)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from ApplicationInstance)
exceptionTimes	Returns the value of ExceptionTimes attribute. This attribute represents set of times periods that define exceptions (non-working times) for the given working times including the base calendar, if provided.
findDataTypes	Retrieves the Named/Defined data types of the entity instance according to the schema types hierarchy. (Inherited from ApplicationInstance)
findRolesOf	Retrieves the identifiers of the attributes of entity instances which refer to the current entity instance within the model. (Inherited from ApplicationInstance)
findUsedIn	Retrieves the identifiers of all entity instances in the model which refer to the entity instance through the specified attribute. (Inherited from ApplicationInstance)
findUsedInBN	Retrieves the identifiers of all the entity instances in the model which refer to the entity instance through the specified attribute name. (Inherited from ApplicationInstance)
findUsers	Retrieves the identifiers of all the entity instances in the model that refer to the current entity instance. (Inherited from ApplicationInstance)
getAttr	Retrieves the current value of an attribute specified by its name. (Inherited from ApplicationInstance)
getAttr	Retrieves the current value of the attribute specified by its name. (Inherited from OdDAIObjectSDAI)
getAttr	Returns an attribute value for the specified attribute definition. (Inherited from IfcObjectDefinition)
getAttr	Retrieves the current value of an attribute specified by its definition. (Inherited from OdIfcInstance)
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttrCaseInsensitive	Retrieves the current value of an attribute specified by its name in case-insensitive mode. (Inherited from OdDAIObjectSDAI)
getDerivedAttr	Calculates a value of a derived attribute specified by its name. (Inherited from ApplicationInstance)
getDescription	Returns the description of an object. (Inherited from IfcRoot)
getExceptionTimes	Gets the value of ExceptionTimes attribute. This attribute represents set of times periods that define exceptions (non-working times) for the given working times including the base calendar, if provided.
getGlobalId	Returns a globally unique identifier within the entire software world. (Inherited from IfcRoot)
getIdentification	Returns the value of Identification attribute. This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level. (Inherited from IfcControl)
getInstanceType	Retrieves the type of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
getInstanceType	Returns a type of a class instance. (Inherited from IfcControl)
getInstanceType	Returns a type of a class instance. (Inherited from IfcObject)
getInstanceType	Returns a type of a class instance. (Inherited from IfcObjectDefinition)
getInstanceType	Returns a type of a class instance. (Inherited from IfcRoot)
getInstanceType	Returns a type of a class instance.
getInvControls	Returns the value of Controls attribute. This attribute represents reference to the relationship that associates the control to the object(s) being controlled. (Inherited from IfcControl)
getInvDeclares	Returns the value of Declares attribute. This attribute represents link to the relationship object pointing to the reflected object(s) that receives the object definitions. The reflected object has to be part of an object occurrence decomposition. The associated IfcObject, or its subtypes, provides the specific information (as part of a type, or style, definition), that is common to all reflected instances of the declaring IfcObject, or its subtypes. (Inherited from IfcObject)
getInvDecomposes	Returns the value of Decomposes attribute. This attribute represents references to the decomposition relationship being an aggregation. It determines that this object definition is a part within an unordered whole/part decomposition relationship. An object definitions can only be part of a single decomposition (to allow hierarchical structures only). (Inherited from IfcObjectDefinition)
getInvHasAssignments	Returns the value of HasAssignments attribute. This attribute represents reference to the relationship objects, that assign (by an association relationship) other subtypes of IfcObject to this object instance. Examples are the association to products, processes, controls, resources or groups. (Inherited from IfcObjectDefinition)
getInvHasAssociations	Returns the value of HasAssociations attribute. This attribute represents reference to the relationship objects, that associates external references or other resource definitions to the object. Examples are the association to library, documentation or classification. (Inherited from IfcObjectDefinition)
getInvHasContext	Returns the value of HasContext attribute. This attribute represents references to the context providing context information such as project unit or representation context. It should only be asserted for the uppermost non-spatial object. (Inherited from IfcObjectDefinition)
getInvIsDeclaredBy	Returns the value of IsDeclaredBy attribute. This attribute represents link to the relationship object pointing to the declaring object that provides the object definitions for this object occurrence. The declaring object has to be part of an object type decomposition. The associated IfcObject, or its subtypes, contains the specific information (as part of a type, or style, definition), that is common to all reflected instances of the declaring IfcObject, or its subtypes. (Inherited from IfcObject)
getInvIsDecomposedBy	Returns the value of IsDecomposedBy attribute. This attribute represents references to the decomposition relationship being an aggregation. It determines that this object definition is whole within an unordered whole/part decomposition relationship. An object definitions can be aggregated by several other objects (occurrences or parts). (Inherited from IfcObjectDefinition)
getInvIsDefinedBy	Returns the value of IsDefinedBy attribute. This attribute represents set of relationships to property set definitions attached to this object. Those statically or dynamically defined properties contain alphanumeric information content that further defines the object. (Inherited from IfcObject)
getInvIsNestedBy	Returns the value of IsNestedBy attribute. This attribute represents references to the decomposition relationship being a nesting. It determines that this object definition is the whole within an ordered whole/part decomposition relationship. An object or object type can be nested by several other objects (occurrences or types). (Inherited from IfcObjectDefinition)
getInvIsTypedBy	Returns the value of IsTypedBy attribute. This attribute represents set of relationships to the object type that provides the type definitions for this object occurrence. The then associated IfcTypeObject, or its subtypes, contains the specific information (or type, or style), that is common to all instances of IfcObject, or its subtypes, referring to the same type. (Inherited from IfcObject)
getInvNests	Returns the value of Nests attribute. This attribute represents references to the decomposition relationship being a nesting. It determines that this object definition is a part within an ordered whole/part decomposition relationship. An object occurrence or type can only be part of a single decomposition (to allow hierarchical structures only). (Inherited from IfcObjectDefinition)
getInverseAttr	Retrieves the current value of an inverse attribute with a specified name. (Inherited from ApplicationInstance)
getName	Returns a name that is used by the participating software systems or users. (Inherited from IfcRoot)
getObjectType	Returns the value of ObjectType attribute. This attribute represents the type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes. In particular it holds the user defined type, if the enumeration of the attribute PredefinedType is set to USERDEFINED. (Inherited from IfcObject)
getOwnerHistory	Returns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object. (Inherited from IfcRoot)
getPredefinedType	Returns the value of PredefinedType attribute. This attribute represents identifies the predefined types of a work calendar from which the type required may be set.
getWorkingTimes	Gets the value of WorkingTimes attribute. This attribute represents set of times periods that are regarded as an initial set-up of working times. Exception times can then further restrict these working times.
gsNode	Retrieves the current Gs node object of the entity. (Inherited from ApplicationInstance)
gsNode	Retrieves the current Gs node object of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
gsNode	Retrieves the current Gs node object of the instance. (Inherited from OdIfcInstance)
id	Retrieves the database object identifier of the application instance. (Inherited from ApplicationInstance)
id	Retrieves the database object identifier of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
inFields	Reads values of the instance's explicit attribute fields from a file buffer that is associated with a specified filer object. (Inherited from ApplicationInstance)
inFields	Reads object's data from the specified filer. (Inherited from IfcControl)
inFields	Reads object's data from the specified filer. (Inherited from IfcObject)
inFields	Reads object's data from the specified filer. (Inherited from IfcObjectDefinition)
inFields	Reads object's data from the specified filer. (Inherited from IfcRoot)
inFields	Reads object's data from the specified filer.
isInstanceOf	Retrieves whether the instance is an instance of a specified type. (Inherited from OdIfcInstance)
isInstanceOf(const Entity *)	This is the overview for the isInstanceOf method overload.
isInstanceOf(const Entity *)	This is the overview for the isInstanceOf method overload.
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcControl)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcObject)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcObjectDefinition)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcRoot)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class.
isKindOf	Retrieves whether the instance belongs to a specified entity type. (Inherited from OdIfcInstance)
isKindOf(const Entity *)	This is the overview for the isKindOf method overload.
isKindOf(const Entity *)	This is the overview for the isKindOf method overload.
isPersistent	Retrieves whether the Standard Data Access Interface (SDAI) object is a persistent one. (Inherited from OdDAIObjectSDAI)
outFields	Writes values of the instance's explicit attribute fields to a file buffer that is assigned to a specified filer object. (Inherited from ApplicationInstance)
outFields	Writes object's data the the specified filer. (Inherited from IfcControl)
outFields	Writes object's data the the specified filer. (Inherited from IfcObject)
outFields	Writes object's data the the specified filer. (Inherited from IfcObjectDefinition)
outFields	Writes object's data the the specified filer. (Inherited from IfcRoot)
outFields	Writes object's data the the specified filer.
owningModel	Retrieves the model that contains the application instance. (Inherited from ApplicationInstance)
owningModel	Retrieves the model object that contains the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
owningStepFile	Retrieves the file that contains the model with this application instance. (Inherited from ApplicationInstance)
putAttr	Sets the specified attribute with a given value. (Inherited from IfcObjectDefinition)
putAttr(const ExplicitAttributePtr &, const OdRxValue&)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttrCaseInsensitive	Sets a new value of an attribute that is specified by its name in the case insensitive mode. (Inherited from ApplicationInstance)
putAttrWithValidation	Sets a new value of an attribute specified with its name after the validation is performed. (Inherited from ApplicationInstance)
resetInverseCounterParts	Removes inverse attributes from related application instances. (Inherited from ApplicationInstance)
resolve	Resolves the instance and returns the result of the instance composition to a calling subroutine. (Inherited from OdIfcInstance)
resolved	Retrieves whether the instance is resolved into a compound object, into a Ge compound object, or is unresolved/visited. (Inherited from OdIfcInstance)
setDescription	Sets the object description. (Inherited from IfcRoot)
setGlobalId	Assigns a globally unique identifier within the entire software world. (Inherited from IfcRoot)
setGsNode	Sets a new Gs node cache for the entity. (Inherited from ApplicationInstance)
setGsNode	Sets a new Gs node cache for the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
setGsNode	Sets a new Gs node cache for the instance. (Inherited from OdIfcInstance)
setIdentification	Sets the value of Identification attribute. This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level. (Inherited from IfcControl)
setInverseCounterParts	Sets inverse attributes to related application instances. (Inherited from ApplicationInstance)
setInverseCounterParts	Sets inverse attributes to related application instances. (Inherited from OdIfc4x2Instance)
setName	Sets the name of the object. (Inherited from IfcRoot)
setObjectType	Sets the value of ObjectType attribute. This attribute represents the type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes. In particular it holds the user defined type, if the enumeration of the attribute PredefinedType is set to USERDEFINED. (Inherited from IfcObject)
setOwnerHistory	Assigns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object. (Inherited from IfcRoot)
setPredefinedType	Sets the value of PredefinedType attribute. This attribute represents identifies the predefined types of a work calendar from which the type required may be set.
subSetAttributes	Sets the values of the entity's sub-entity traits. (Inherited from ApplicationInstance)
subSetAttributes	Sets the values of the instance's sub-entity traits. (Inherited from OdIfcInstance)
subWorldDraw	Draws a graphical entity representation that is independent of any viewport context. (Inherited from ApplicationInstance)
subWorldDraw	Draws a graphical instance representation that is independent of any viewport context. (Inherited from OdIfcInstance)
testAttr(const AttributePtr&)	This is the overview for the testAttr method overload.
testAttr(const AttributePtr&)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttrCaseInsensitive	Retrieves whether the attribute value is set or is unset. The specified attribute name is case-insensitive. (Inherited from OdDAIObjectSDAI)
type	Returns the type of this entity. (Inherited from IfcControl)
type	Returns the type of this entity. (Inherited from IfcObject)
type	Returns the type of this entity. (Inherited from IfcObjectDefinition)
type	Returns the type of this entity. (Inherited from IfcRoot)
type	Returns the type of this entity.
type	Retrieves the current type of the instance. (Inherited from OdIfcInstance)
typeName	Retrieves the type name of the application instance. (Inherited from ApplicationInstance)
unresolve	Unresolves the instance. (Inherited from OdIfcInstance)
unsetAttr(const AttributePtr&)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttrCaseInsensitive	Checks whether the value of a specified attribute is set. (Inherited from ApplicationInstance)
validateAggrSize	Checks whether the instance has aggregate attributes, which violate size constraints and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateAggrUniqueness	Checks whether application instance aggregate attributes has unique items in the case if aggregation type of attribute UNIQUE flag is turned on. (Inherited from ApplicationInstance)
validateArrayNotOptional	Checks whether a specified array instances which don't assume optional attributes (i.e. attributes that can't have unset value) have attribute values. (Inherited from ApplicationInstance)
validateBinaryWidth	Checks whether the instance has binary attributes with incorrect width and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateExplicitAttrsReferences	Checks whether each entity instance that represents the value of a specified instance attribute has a valid entity data type. (Inherited from ApplicationInstance)
validateInverseAttrs	Checks whether the instance has inverse attributes with violated size constraints and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateRequiredExplicitAttrsAssigned	Checks whether the instance has unset mandatory attributes and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateStringWidth	Checks whether the instance has string attributes with incorrect width and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateWhereRule(const WhereRule *)	This is the overview for the validateWhereRule method overload.
workingTimes	Returns the value of WorkingTimes attribute. This attribute represents set of times periods that are regarded as an initial set-up of working times. Exception times can then further restrict these working times.

Links

IfcWorkCalendar Methods

Relief for ODA Team in Ukraine