WSM::Utils::HistoryObjects Class Reference

Description

This is a helper class to convert the many representations of Objects used by the WSM APIs.class HistoryObjects.

This class is used for the JS API to make it easier to take results from one API and call another API without having to convert the Object representation in JS code. Automatic conversions from:

GroupInstancePath
GroupInstancePathArray
ObjectHistoryIDArray
ObjectHistoryID
ObjectIDArray
size_t

To:

GroupInstancePath
GroupInstancePathArray
ObjectHistoryIDArray
ObjectHistoryID
ObjectIDArray

#include <historyobjects.h>

Public Member Functions
	HistoryObjects ()
	HistoryObjects (GroupInstancePath const &obj)
	HistoryObjects (GroupInstancePathArray const &objs)
	HistoryObjects (ObjectHistoryIDArray const &objs)
	HistoryObjects (ObjectHistoryID const &obj)
	HistoryObjects (ObjectIDArray const &objectIDs)
	HistoryObjects (size_t objectID)
	HistoryObjects (json &jin, 1::string const &objectsKey, 1::string history="NOTSPECIFIED", 1::string groupInstancePathKey="NOTSPECIFIED")
	ctor used for JS API. More...
size_t	GetHistory () const
	Get the History ID all the Object IDs belong to. More...
bool	HasHistory () const
	Check if HistoryObjects has a valid History. More...
bool	IsAlive ()
	Check to see if everything is alive. More...
	operator GroupInstancePath const & ()
	Cast operators. More...
	operator GroupInstancePathArray const & ()
	operator ObjectHistoryIDArray const & ()
	operator ObjectIDArray const & ()
	operator ObjectHistoryID const & ()
HistoryObjects &	operator= (GroupInstancePath const &)
	Assignment operators. More...
HistoryObjects &	operator= (GroupInstancePathArray const &)
HistoryObjects &	operator= (ObjectHistoryIDArray const &)
HistoryObjects &	operator= (ObjectIDArray const &)
bool	operator== (HistoryObjects &r)
void	SetGroupInstancePath (const GroupInstancePath &path)
	Set the instance path. More...
void	Clear ()
	Clear all the data. More...

Constructor & Destructor Documentation

WSM::Utils::HistoryObjects::HistoryObjects ( )

inline

WSM::Utils::HistoryObjects::HistoryObjects ( GroupInstancePath const &  obj )

inline

WSM::Utils::HistoryObjects::HistoryObjects ( GroupInstancePathArray const &  objs )

inline

WSM::Utils::HistoryObjects::HistoryObjects ( ObjectHistoryIDArray const &  objs )

inline

WSM::Utils::HistoryObjects::HistoryObjects ( ObjectHistoryID const &  obj )

inline

WSM::Utils::HistoryObjects::HistoryObjects

(

ObjectIDArray const &

objectIDs

)

WSM::Utils::HistoryObjects::HistoryObjects ( size_t  objectID )

inline

WSM::Utils::HistoryObjects::HistoryObjects	(	json &	jin,
		1::string const &	objectsKey,
		1::string	history = "NOTSPECIFIED",
		1::string	groupInstancePathKey = "NOTSPECIFIED"
	)

ctor used for JS API.

Member Function Documentation

void WSM::Utils::HistoryObjects::Clear

(

)

Clear all the data.

size_t WSM::Utils::HistoryObjects::GetHistory ( ) const

inline

Get the History ID all the Object IDs belong to.

bool WSM::Utils::HistoryObjects::HasHistory ( ) const

inline

Check if HistoryObjects has a valid History.

bool WSM::Utils::HistoryObjects::IsAlive

(

)

Check to see if everything is alive.

WSM::Utils::HistoryObjects::operator GroupInstancePath const &

(

)

Cast operators.

WSM::Utils::HistoryObjects::operator GroupInstancePathArray const &

(

)

WSM::Utils::HistoryObjects::operator ObjectHistoryID const &

(

)

WSM::Utils::HistoryObjects::operator ObjectHistoryIDArray const &

(

)

WSM::Utils::HistoryObjects::operator ObjectIDArray const &

(

)

HistoryObjects& WSM::Utils::HistoryObjects::operator=

(

GroupInstancePath const &

)

Assignment operators.

HistoryObjects& WSM::Utils::HistoryObjects::operator=

(

GroupInstancePathArray const &

)

HistoryObjects& WSM::Utils::HistoryObjects::operator=

(

ObjectHistoryIDArray const &

)

HistoryObjects& WSM::Utils::HistoryObjects::operator=

(

ObjectIDArray const &

)

bool WSM::Utils::HistoryObjects::operator==

(

HistoryObjects &

r

)

void WSM::Utils::HistoryObjects::SetGroupInstancePath ( const GroupInstancePath &  path )

inline

Set the instance path.

---

The documentation for this class was generated from the following file:

• WSMUtils/historyobjects.h