Legion::ReadStateInstance Class Reference

The ReadStateInstance is the base class of all read simulation object repository classes. More...

Inheritance diagram for Legion::ReadStateInstance:

Collaboration diagram for Legion::ReadStateInstance:

Public Member Functions
	ReadStateInstance ()
	constructors More...
	ReadStateInstance (InstanceHandle instanceId)
	ReadStateInstance (const ReadStateInstance &orig)
	copy constructor More...
ReadStateInstance &	operator= (const ReadStateInstance &orig)
	assignment operator More...
virtual	~ReadStateInstance ()
	destructor. This will not destroy the underlying object, just this interface class to the object More...
virtual bool	isValid () const
	Does this class reference a valid simulation object instance in the database. More...
virtual InstanceHandle	instanceHandle () const
	Get the instance ID of the simulation object that this state repository references. More...
virtual GlobalIdentifier	globalId () const
	Get the global ID of the simulation object that this state repository references. More...
virtual AttributeSetId	setType () const
	get the type of simulation object of this instance. More...
DatabaseHandle	database () const
	get the database that owns this object More...
template<typename DATA_TYPE >
DATA_TYPE	data (AttributeIndex attributeIndex) const
	Read the data of a given attribute that is available in the current frame. More...
template<typename DATA_TYPE >
const Span< DATA_TYPE >	dataArray (AttributeIndex attributeIndex) const
	Read the array data of a given attribute that is available in the current frame. More...
virtual UInt32	dataArrayCount (AttributeIndex attributeIndex) const
	Get the length of the array data of a given attribute. More...
virtual bool	hasParent () const
	get the parent of this instance, if it exists More...
virtual Legion::InstanceHandle	getParent () const
template<typename COMP_TYPE >
COMP_TYPE	findParent () const
virtual int	extensionCount () const
virtual Legion::InstanceHandle	getExtension (int index) const
virtual Legion::Span < Legion::InstanceHandle >	extensions () const
template<typename COMP_TYPE >
COMP_TYPE	findTypeExtension (int index) const
template<typename COMP_TYPE >
int	typeExtensionCount () const
template<typename COMP_TYPE >
std::vector< COMP_TYPE >	getTypeExtensions () const

Static Public Member Functions
static AttributeSetId	setType (InstanceHandle id)

Protected Attributes
InstanceHandle	myInstanceHandle

Detailed Description

The ReadStateInstance is the base class of all read simulation object repository classes.

It provides generic access to attributes. Values read from a ReadStateInstance will be consistent with the context of a frame of simulation. ReadStateInstance is an interface class that provides generic access to the internal database representation of the simulation object. It does not store any simulation data itself. All derived ReadStateInstance classes must implement a static AttributeSetId type() function that returns the attribute set ID of the derived class.

Constructor & Destructor Documentation

Legion::ReadStateInstance::ReadStateInstance

(

)

constructors

Legion::ReadStateInstance::ReadStateInstance ( InstanceHandle  instanceId )

explicit

Legion::ReadStateInstance::ReadStateInstance

(

const ReadStateInstance &

orig

)

copy constructor

virtual Legion::ReadStateInstance::~ReadStateInstance ( )

virtual

destructor. This will not destroy the underlying object, just this interface class to the object

Member Function Documentation

template<typename DATA_TYPE >

DATA_TYPE Legion::ReadStateInstance::data

(

AttributeIndex

attributeIndex

)

const

Read the data of a given attribute that is available in the current frame.

template<typename DATA_TYPE >

const Span<DATA_TYPE> Legion::ReadStateInstance::dataArray

(

AttributeIndex

attributeIndex

)

const

Read the array data of a given attribute that is available in the current frame.

virtual UInt32 Legion::ReadStateInstance::dataArrayCount ( AttributeIndex  attributeIndex ) const

virtual

Get the length of the array data of a given attribute.

DatabaseHandle Legion::ReadStateInstance::database

(

)

const

get the database that owns this object

virtual int Legion::ReadStateInstance::extensionCount ( ) const

virtual

Referenced by findTypeExtension(), getTypeExtensions(), and typeExtensionCount().

virtual Legion::Span<Legion::InstanceHandle> Legion::ReadStateInstance::extensions ( ) const

virtual

template<typename COMP_TYPE >

COMP_TYPE Legion::ReadStateInstance::findParent

(

)

const

References getParent().

template<typename COMP_TYPE >

COMP_TYPE Legion::ReadStateInstance::findTypeExtension

(

int

index

)

const

References extensionCount(), and getExtension().

Referenced by main().

virtual Legion::InstanceHandle Legion::ReadStateInstance::getExtension ( int  index ) const

virtual

Referenced by findTypeExtension(), getTypeExtensions(), and typeExtensionCount().

virtual Legion::InstanceHandle Legion::ReadStateInstance::getParent ( ) const

virtual

Referenced by findParent().

template<typename COMP_TYPE >

std::vector< COMP_TYPE > Legion::ReadStateInstance::getTypeExtensions

(

)

const

References extensionCount(), and getExtension().

virtual GlobalIdentifier Legion::ReadStateInstance::globalId ( ) const

virtual

Get the global ID of the simulation object that this state repository references.

virtual bool Legion::ReadStateInstance::hasParent ( ) const

virtual

get the parent of this instance, if it exists

virtual InstanceHandle Legion::ReadStateInstance::instanceHandle ( ) const

inlinevirtual

Get the instance ID of the simulation object that this state repository references.

virtual bool Legion::ReadStateInstance::isValid ( ) const

virtual

Does this class reference a valid simulation object instance in the database.

Referenced by main().

ReadStateInstance& Legion::ReadStateInstance::operator=

(

const ReadStateInstance &

orig

)

assignment operator

static AttributeSetId Legion::ReadStateInstance::setType ( InstanceHandle  id )

static

virtual AttributeSetId Legion::ReadStateInstance::setType ( ) const

virtual

get the type of simulation object of this instance.

template<typename COMP_TYPE >

int Legion::ReadStateInstance::typeExtensionCount

(

)

const

References extensionCount(), and getExtension().

Member Data Documentation

InstanceHandle Legion::ReadStateInstance::myInstanceHandle

protected

Referenced by ReadEngineRepository::operator=(), and ReadEngineRepository::ReadEngineRepository().

---

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

• readStateInstance.h