OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | List of all members
openstudio::IdfObjectDiff Class Reference

#include <IdfObjectDiff.hpp>

+ Inheritance diagram for openstudio::IdfObjectDiff:

Public Member Functions

template<typename T >
cast () const
 cast to type T, can throw std::bad_cast More...
 
 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) More...
 
bool isNull () const
 returns true if oldValue == newValue More...
 
boost::optional< std::string > newValue () const
 get the new value, uninitialized optional means that the field no longer exists More...
 
boost::optional< std::string > oldValue () const
 get the old value, uninitialized optional means that the field did not previously exist More...
 
template<typename T >
boost::optional< T > optionalCast () const
 cast to optional of type T More...
 

Protected Member Functions

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

Detailed Description

IdfObjectDiff represents a change to an IdfObject.

Constructor & Destructor Documentation

openstudio::IdfObjectDiff::IdfObjectDiff ( )
openstudio::IdfObjectDiff::IdfObjectDiff ( boost::optional< unsigned >  index,
boost::optional< std::string >  oldValue,
boost::optional< std::string >  newValue 
)
openstudio::IdfObjectDiff::IdfObjectDiff ( const std::shared_ptr< detail::IdfObjectDiff_Impl > &  impl)
protected

Member Function Documentation

template<typename T >
T openstudio::IdfObjectDiff::cast ( ) const
inline

cast to type T, can throw std::bad_cast

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

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

bool openstudio::IdfObjectDiff::isNull ( ) const

returns true if oldValue == newValue

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

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

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

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

template<typename T >
boost::optional<T> openstudio::IdfObjectDiff::optionalCast ( ) const
inline

cast to optional of type T