OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::WorkspaceObjectDiff Class Reference

#include <WorkspaceObjectDiff.hpp>

+ Inheritance diagram for openstudio::WorkspaceObjectDiff:

Public Member Functions

boost::optional< UUIDnewHandle () const
 get the new handle if there is one, use newValue to determine if field exists or not
 
boost::optional< UUIDoldHandle () const
 get the old handle if there was one, use oldValue to determine if field existed or not
 
 WorkspaceObjectDiff (unsigned index, boost::optional< std::string > oldValue, boost::optional< std::string > newValue, boost::optional< UUID > oldHandle, boost::optional< UUID > newHandle)
 
- Public Member Functions inherited from openstudio::IdfObjectDiff
template<typename T >
cast () const
 cast to type T, can throw std::bad_cast
 
 IdfObjectDiff ()
 
 IdfObjectDiff (boost::optional< unsigned > index, boost::optional< std::string > oldValue, boost::optional< std::string > newValue)
 
boost::optional< unsigned > index () const
 get the index that changed, uninitialized means no field (e.g. object level comment changed)
 
bool isNull () const
 returns true if oldValue == newValue
 
boost::optional< std::string > newValue () const
 get the new value, uninitialized optional means that the field no longer exists
 
boost::optional< std::string > oldValue () const
 get the old value, uninitialized optional means that the field did not previously exist
 
template<typename T >
boost::optional< T > optionalCast () const
 cast to optional of type T
 

Additional Inherited Members

- Protected Member Functions inherited from openstudio::IdfObjectDiff
 IdfObjectDiff (const std::shared_ptr< detail::IdfObjectDiff_Impl > &impl)
 

Detailed Description

WorkspaceObjectDiff represents a change to an WorkspaceObjectDiff.

Constructor & Destructor Documentation

◆ WorkspaceObjectDiff()

openstudio::WorkspaceObjectDiff::WorkspaceObjectDiff ( unsigned index,
boost::optional< std::string > oldValue,
boost::optional< std::string > newValue,
boost::optional< UUID > oldHandle,
boost::optional< UUID > newHandle )

Member Function Documentation

◆ newHandle()

boost::optional< UUID > openstudio::WorkspaceObjectDiff::newHandle ( ) const

get the new handle if there is one, use newValue to determine if field exists or not

◆ oldHandle()

boost::optional< UUID > openstudio::WorkspaceObjectDiff::oldHandle ( ) const

get the old handle if there was one, use oldValue to determine if field existed or not