#include <IdfObjectDiff.hpp>

Inheritance diagram for openstudio::IdfObjectDiff:

Public Member Functions
template<typename T >
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

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

Detailed Description

IdfObjectDiff represents a change to an IdfObject.

Constructor & Destructor Documentation

◆ IdfObjectDiff() [1/3]

openstudio::IdfObjectDiff::IdfObjectDiff ( )

◆ IdfObjectDiff() [2/3]

openstudio::IdfObjectDiff::IdfObjectDiff	(	boost::optional< unsigned >	index,
		boost::optional< std::string >	oldValue,
		boost::optional< std::string >	newValue )

◆ IdfObjectDiff() [3/3]

openstudio::IdfObjectDiff::IdfObjectDiff ( const std::shared_ptr< detail::IdfObjectDiff_Impl > & impl )

protected

Member Function Documentation

◆ cast()

template<typename T >

T openstudio::IdfObjectDiff::cast ( ) const

inline

cast to type T, can throw std::bad_cast

◆ index()

boost::optional< unsigned > openstudio::IdfObjectDiff::index ( ) const

get the index that changed, uninitialized means no field (e.g. object level comment changed)

◆ isNull()

bool openstudio::IdfObjectDiff::isNull ( ) const

returns true if oldValue == newValue

◆ newValue()

boost::optional< std::string > openstudio::IdfObjectDiff::newValue ( ) const

get the new value, uninitialized optional means that the field no longer exists

◆ oldValue()

boost::optional< std::string > openstudio::IdfObjectDiff::oldValue ( ) const

get the old value, uninitialized optional means that the field did not previously exist

◆ optionalCast()