DtRwSimObjectReferenceList Class Reference

If you use a list of object names to archive which objects are part of a controller (or any object) use this list instead. It will read the names of the objects from th stream and create object references to that object. It will also remove objects from the list that are removed from the object manager so it will be kept up to date at all times.

Inheritance diagram for DtRwSimObjectReferenceList:

Public Member Functions
	DtRwSimObjectReferenceList (const DtSimulationServices *)
	DtRwSimObjectReferenceList (const DtSimulationServices *, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwSimObjectReferenceList (const DtString &name, const DtRwSimObjectReferenceList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwSimObjectReferenceList (const DtRwSimObjectReferenceList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwSimObjectReferenceList ()
DtRwSimObjectReferenceList &	operator= (const DtRwSimObjectReferenceList &)
DtRwSimObjectReferenceList &	operator= (const DtSimObjectReferenceList &)
	operator const DtSimObjectReferenceList () const
	operator DtSimObjectReferenceList ()
const DtSimObjectReferenceList &	simObjectReferenceList () const
DtSimObjectReferenceList &	simObjectReferenceList ()
virtual void	removeAll ()
virtual void	removeAndDeleteAll ()
virtual DtSimObjectReference	findUUID (const DtUUID &) const
virtual void	copyWithoutConnect (const DtRwSimObjectReferenceList &)
virtual void	addUUID (const DtUUID &, int index=-1)
virtual bool	removeUUID (const DtUUID &)
bool	hasUUID (const DtUUID &) const
virtual std::vector< DtRwUUID >	uuidsAsVector () const
virtual std::list< DtRwUUID >	uuidsAsList () const
virtual DtSimObjectReference	first () const
virtual DtSimObjectReference	last () const
DtSimObjectReference	simObject (const DtUUID &u) const
virtual void	disconnect ()
virtual void	connect ()
int	size () const
DtSimObjectReferenceList::iterator	begin ()
DtSimObjectReferenceList::iterator	end ()
DtSimObjectReferenceList::const_iterator	begin () const
DtSimObjectReferenceList::const_iterator	end () const
Public Member Functions inherited from DtRwTemplatedListPtr< DtRwUUID, true >
	DtRwTemplatedListPtr ()
	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)
virtual	~DtRwTemplatedListPtr ()
virtual DtReaderWriter *	createPrototype (const char *name="") const override
DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual DtListItem *	insertItemAt (DtRwUUID *data, int index)
virtual DtListItem *	add (DtReaderWriter *item) override
virtual DtListItem *	add (DtRwUUID *data)
void	removeAll ()
void *	remove (DtListItem *item)
void *	remove (DtRwUUID *item)
virtual std::set< DtString >	supportedXmlTypes () const
void	removeAndDeleteAll () override
bool	operator== (const DtRwTemplatedListPtr &) const
bool	operator!= (const DtRwTemplatedListPtr &) const
virtual const char *	xmlType () const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
DtListItem *	find (boost::function< bool(const DtRwUUID &)> predFcn) const
virtual DtString	prettyPrint () const
const char *	readerWriterType () const
void	copyList (const DtRwTemplatedListPtr &orig)
Public Member Functions inherited from DtRwList
	DtRwList ()
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
virtual DtListItem *	addToStart (DtReaderWriter *data)
virtual DtListItem *	addToEnd (DtReaderWriter *data)
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
virtual void	reset ()
bool	operator== (const DtRwList &rhs) const
bool	operator!= (const DtRwList &rhs) const
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual void	slot_uuidUpgradedTo (const DtUUID &oldUUID, const DtUUID &newUUID)
virtual void	postGetSelf () override
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
bool	myConnectedForRemoval
DtSimObjectReferenceList	mySimObjectReferenceList
boost::signals2::scoped_connection	myUUIDUpgradedToConnection
Protected Attributes inherited from DtRwTemplatedListPtr< DtRwUUID, true >
DtString	myXmlType
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtRwTemplatedListPtr< DtRwUUID, true >
typedef DtIteratorBase< DtRwUUID >	iterator
typedef DtIteratorBase< const DtRwUUID >	const_iterator
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtRwTemplatedListPtr< DtRwUUID, true >
static const char *	theXmlType ()
static const char *	ListReaderWriterType ()
Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtRwSimObjectReferenceList::DtRwSimObjectReferenceList

(

const DtSimulationServices *

)

default constructor

DtRwSimObjectReferenceList::DtRwSimObjectReferenceList	(	const DtSimulationServices *	,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtRwSimObjectReferenceList::DtRwSimObjectReferenceList	(	const DtString &	name,
		const DtRwSimObjectReferenceList &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwSimObjectReferenceList::DtRwSimObjectReferenceList	(	const DtRwSimObjectReferenceList &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtRwSimObjectReferenceList::~DtRwSimObjectReferenceList ( )

virtual

Member Function Documentation

DtRwSimObjectReferenceList& DtRwSimObjectReferenceList::operator=

(

const DtRwSimObjectReferenceList &

)

DtRwSimObjectReferenceList& DtRwSimObjectReferenceList::operator=

(

const DtSimObjectReferenceList &

)

DtRwSimObjectReferenceList::operator const DtSimObjectReferenceList ( ) const

inline

DtRwSimObjectReferenceList::operator DtSimObjectReferenceList ( )

inline

const DtSimObjectReferenceList& DtRwSimObjectReferenceList::simObjectReferenceList ( ) const

inline

DtSimObjectReferenceList& DtRwSimObjectReferenceList::simObjectReferenceList ( )

inline

virtual void DtRwSimObjectReferenceList::removeAll ( )

virtual

Removes all the items in the list.

Reimplemented from DtRwList.

virtual void DtRwSimObjectReferenceList::removeAndDeleteAll ( )

virtual

Removes and deletes all items in the list.

Reimplemented from DtRwList.

virtual DtSimObjectReference DtRwSimObjectReferenceList::findUUID ( const DtUUID &  ) const

virtual

Returns object referenced by this UUID.

virtual void DtRwSimObjectReferenceList::copyWithoutConnect ( const DtRwSimObjectReferenceList &  )

virtual

Copies the list and turns off connections.

virtual void DtRwSimObjectReferenceList::addUUID ( const DtUUID &  , int  index = -1  )

virtual

Adds a new object that is referenced by this UUID.

virtual bool DtRwSimObjectReferenceList::removeUUID ( const DtUUID &  )

virtual

Removes the object referenced by this UUID.

bool DtRwSimObjectReferenceList::hasUUID

(

const DtUUID &

)

const

Returns true if the UUID is in this list.

virtual std::vector<DtRwUUID> DtRwSimObjectReferenceList::uuidsAsVector ( ) const

virtual

Returns a vector of UUIDs in this list.

virtual std::list<DtRwUUID> DtRwSimObjectReferenceList::uuidsAsList ( ) const

virtual

Returns a list of UUIDs in this list.

virtual DtSimObjectReference DtRwSimObjectReferenceList::first ( ) const

virtual

virtual DtSimObjectReference DtRwSimObjectReferenceList::last ( ) const

virtual

DtSimObjectReference DtRwSimObjectReferenceList::simObject ( const DtUUID &  u ) const

inline

virtual void DtRwSimObjectReferenceList::disconnect ( )

virtual

Disconnect from current and furture removals. Call connect() to turn back on.

virtual void DtRwSimObjectReferenceList::connect ( )

virtual

int DtRwSimObjectReferenceList::size ( ) const

inline

DtSimObjectReferenceList::iterator DtRwSimObjectReferenceList::begin ( )

inline

DtSimObjectReferenceList::iterator DtRwSimObjectReferenceList::end ( )

inline

DtSimObjectReferenceList::const_iterator DtRwSimObjectReferenceList::begin ( ) const

inline

DtSimObjectReferenceList::const_iterator DtRwSimObjectReferenceList::end ( ) const

inline

virtual void DtRwSimObjectReferenceList::slot_uuidUpgradedTo ( const DtUUID &  oldUUID, const DtUUID &  newUUID  )

protectedvirtual

When a UUID is imported as part of an upgrade process, if this list has the old, remove the old and insert the new.

virtual void DtRwSimObjectReferenceList::postGetSelf ( )

overrideprotectedvirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

bool DtRwSimObjectReferenceList::myConnectedForRemoval

protected

DtSimObjectReferenceList DtRwSimObjectReferenceList::mySimObjectReferenceList

protected

boost::signals2::scoped_connection DtRwSimObjectReferenceList::myUUIDUpgradedToConnection

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/simObjectReferenceList.h