API Guides > ConceptRT 3.x
BaseConceptStaticList Class Referenceabstract

BaseConceptStaticList. Base class for ConceptStaticList. More...

Detailed Description

+ Inheritance diagram for BaseConceptStaticList:

Public Member Methods

void ReadFrom (IDataStore &dataStore, IMessageCollector *messages=NULL)
 Reads from. More...
 
void WriteTo (IDataStore &dataStore) const
 Writes to. More...
 
bool GetFull () const
 Query if the list is full. More...
 
bool GetEmpty () const
 Query if the list is empty. More...
 
Int32 GetCount () const
 Gets the number of items contained in the list. More...
 
void Clear ()
 Clears all items. More...
 
void RemoveAt (Int32 index)
 Removes an item at index. More...
 
void Exchange (Int32 index1, Int32 index2)
 Exchanges two items. More...
 
void Move (Int32 index1, Int32 index2)
 Moves an item. More...
 
bool IndexValid (Int32 index) const
 Query if index is valid. More...
 
- Public Member Methods inherited from ConceptList
 ConceptList ()
 Default constructor. More...
 
 ConceptList (const ConceptList &right)
 Default constructor. More...
 
ConceptListoperator= (const ConceptList &right)
 Assignment operator. More...
 
Int32 Add (ConceptElement &element)
 Adds element. More...
 
Int32 Add (ConceptElement &element, const PCChar8 name)
 Adds element. More...
 
void AddRange (const IReferenceList< ConceptElement > &list)
 Adds a range of element. More...
 
void Insert (Int32 index, ConceptElement &element)
 Inserts a reference. More...
 
Int32 IndexOf (const ConceptElement &element) const
 Index of the given reference. More...
 
Int32 Remove (const ConceptElement &element)
 Removes an reference at index. More...
 
ConceptElementSwap (ConceptElement &element, Int32 index)
 Swaps. More...
 
ConceptElementoperator[] (Int32 index) const
 Array indexer operator. More...
 
void Accept (IContainerVisitor &visitor)
 Accepts IContainerVisitor to access the object published fields. More...
 
bool IsNameUnique (PCChar8 name, ConceptElement *element=NULL)
 Query if 'name' is an unique name . More...
 
String GenerateUniqueName (PCChar8 baseName="Item", ConceptElement *element=NULL)
 Generates a unique name. More...
 
- Public Member Methods inherited from ConceptContainer
const bool & GetIsXmlPropertyVisible () const
 Show the xml field in the invocation. More...
 
const bool & GetIsXmlPropertyVisible ()
 Show the xml field in the invocation. More...
 
void SetIsXmlPropertyVisible (const bool &value)
 Show the xml field in the invocation. More...
 
const bool & GetIsXmlPropertyReadOnly () const
 Control access on the xml file shown in the invocation. More...
 
const bool & GetIsXmlPropertyReadOnly ()
 Control access on the xml file shown in the invocation. More...
 
void SetIsXmlPropertyReadOnly (const bool &value)
 Control access on the xml file shown in the invocation. More...
 
 ConceptContainer ()
 Default constructor. More...
 
 ~ConceptContainer ()
 Destructor. More...
 
bool Contains (ConceptElement &element) const
 Query if this object contains the given element. More...
 
void ResolveLinks ()
 Resolve links. More...
 
void Invoke (const DynamicInvocationRequest &request, DynamicInvocationResult &result)
 Invokes the object fields and methods. More...
 
ConceptElementFind (const PCChar8 path) const
 Searches into the container and sub-containers an element. More...
 
virtual ConceptElementFindByName (const PCChar8 name) const
 Searches into the container an element. More...
 
template<class ElementSubType >
ElementSubType * FindByName (const PCChar8 name) const
 Searches into the container an element of a certain type. More...
 
void RetrieveProvidedFactories (BaseConceptFactories &factories, const Predicate< BaseConceptFactory & > &filter)
 Retrieve provided factories. More...
 
void RetrieveProvidedFactories (BaseConceptFactories &factories)
 RetrieveProvidedFactories. More...
 
void RetrieveFactories (BaseConceptFactories &factories) const
 Retrieve factories. More...
 
- Public Member Methods inherited from ConceptElement
const bool & GetIsInvocable () const
 Controls if the objet should be shown in the invocation. More...
 
const bool & GetIsInvocable ()
 Controls if the objet should be shown in the invocation. More...
 
void SetIsInvocable (const bool &value)
 Controls if the objet should be shown in the invocation. More...
 
const bool & GetIsSerialized () const
 Controls if the objet should be serialized. More...
 
const bool & GetIsSerialized ()
 Controls if the objet should be serialized. More...
 
void SetIsSerialized (const bool &value)
 Controls if the objet should be serialized. More...
 
 ConceptElement ()
 Default constructor. More...
 
 ConceptElement (const ConceptElement &right)
 Default constructor. More...
 
ConceptElementoperator= (const ConceptElement &right)
 Assignment operator. More...
 
const StaticString< ConceptElementNameMaxLength > & GetName () const
 Gets the name. More...
 
void SetName (const PCChar8 name)
 Sets a name. More...
 
String GetPath () const
 Gets the path of the ConceptElement. More...
 
ConceptContainerGetContainer () const
 Gets the container of the ConceptElement. More...
 
template<class ContainerType >
ContainerType * GetContainerOfType () const
 Gets the container of a certain type the ConceptElement. More...
 
ConceptContainerGetRootContainer () const
 Gets the root container of the ConceptElement. More...
 
virtual const String GetDisplayName () const
 Gets the display name. More...
 
virtual void CopyDataFrom (const ConceptElement &source)
 Copies the data from another ConceptElement. More...
 
virtual void CopyFrom (const ConceptElement &source)
 Copies itself from a given source. More...
 
virtual BaseConceptFactoryGetFactory () const =0
 Gets the ConceptElement factory. More...
 
ConceptElementGetProvider () const
 Gets the provider of the ConceptElement if defined, throws a ConceptException otherwise. More...
 
template<class T >
T & GetProvider () const
 Gets the provider of the ConceptElement if defined and of type T, throws a ConceptException otherwise. More...
 
bool GetHasProvider () const
 Tests the existence of a provider. More...
 
template<class T >
bool GetHasProvider () const
 Tests the existence of a provider of type T. More...
 
virtual ConceptElementClone () const
 Makes a deep copy of this object. More...
 
void RetrieveProvidedFactories (BaseConceptFactories &factories)
 Retrieve provided factories. More...
 
Variant GetPropertyMetaData (PCChar8 propertyName, PCChar8 metaDataName, const Variant &defaultValue=Variant::GetVariantNull()) const
 Returns a metadata string corresponding to a property and a metadata name. More...
 
- Public Member Methods inherited from IMonomorphousList
virtual Int32 AddNewItem ()=0
 Adds new item. More...
 
virtual void InsertNew (Int32 position)=0
 Inserts a new item at a given position. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ConceptElement
void Initialize ()
 Initializes this object. More...
 
virtual BaseConceptFactoryInternalGetFactory () const
 Gets the object factory. More...
 
virtual void RetrieveElementProvidedFactories (BaseConceptFactories &factories, const Predicate< BaseConceptFactory & > &filter)
 RetrieveElementProvidedFactories. Used by the macro CONCEPT_PROVIDED_COMPONENT_BEGIN More...
 

Methods Documentation

void Clear ( )
inlinevirtual

Clears all items.

Implements IMonomorphousList.

void Exchange ( Int32  index1,
Int32  index2 
)
inlinevirtual

Exchanges two items.

Parameters
index1The first item index.
index2The second item index.
RT Exceptions:
RT_ERROR_OUT_OF_BOUND_INDEX

Implements IMonomorphousList.

Int32 GetCount ( ) const
inlinevirtual

Gets the number of items contained in the list.

Returns
The number of items.

Implements IMonomorphousList.

bool GetEmpty ( ) const
inlinevirtual

Query if the list is empty.

Returns
true if it empty.

Implements IMonomorphousList.

bool GetFull ( ) const
inlinevirtual

Query if the list is full.

Returns
true if it full.

Implements IMonomorphousList.

bool IndexValid ( Int32  index) const
inlinevirtual

Query if index is valid.

Parameters
indexZero-based index of the.
Returns
true if it valid.

Implements IMonomorphousList.

void Move ( Int32  index1,
Int32  index2 
)
inlinevirtual

Moves an item.

Parameters
index1The item index to move.
index2The destination index.
RT Exceptions:
RT_ERROR_OUT_OF_BOUND_INDEX

Implements IMonomorphousList.

void ReadFrom ( IDataStore dataStore,
IMessageCollector messages = NULL 
)
virtual

Reads from.

Parameters
dataStore[in,out] The dataStore.
messages[in,out] (optional) The messageCollector to collect warning or error messages. Default = NULL.
RT Exceptions:

RT_ERROR_DESERIALIZATION_LOAD_OBJECT

RT_ERROR_DATASTORE_TYPE_INCOMPATIBLE

RT_ERROR_INTERNAL_OBJECT_NOT_CREATED

RT_ERROR_INTERNAL_OBJECT_TYPE_NOT_SUPPORTED

Implements ConceptElement.

void RemoveAt ( Int32  index)
inlinevirtual

Removes an item at index.

Parameters
indexZero-based index of the item.
RT Exceptions:
RT_ERROR_OUT_OF_BOUND_INDEX

Implements IMonomorphousList.

void WriteTo ( IDataStore dataStore) const
virtual

Writes to.

Parameters
dataStore[in,out] The dataStore.

Implements ConceptElement.