AfrFoundation CATAfrCommandHeaderArgs
Usage: you must use this class as is. You should never derive it.
public class CATAfrCommandHeaderArgs
Class representing an argument list.
Role: Argument list for a command header to pass to its command.
The command may use in its constructor to get the argument list.
Constructor and Destructor Index
- o
CATAfrCommandHeaderArgs()
- Constructs an empty argument list.
- o
CATAfrCommandHeaderArgs(CATAfrCommandHeaderArgs&)
- Constructs an argument list by copying another one.
- o
~CATAfrCommandHeaderArgs()
-
Method Index
- o
CreateIterator()
- Returns an iterator.
- o
GetArgsCount()
- Get the number of stored arguments.
- o
GetItems()
- Returns the list of arguments as a CATBaseUnknown_var.
- o
Remove(CATString)
- Remove an argument from its Id.
- o
RemoveAll()
- Remove all arguments to empty the list.
- o
Set(CATString,CATBaseUnknown_var,CATAfrCommandHeaderArg::ArgumentMode)
- Changes the value of an argument from its Id or creates the argument if it does not exist.
- o
operator=(CATAfrCommandHeaderArgs&)
- Sets an argument list to the contents of another one.
Constructor and Destructor
o CATAfrCommandHeaderArgs
| public CATAfrCommandHeaderArgs( | ) |
-
Constructs an empty argument list.
o CATAfrCommandHeaderArgs
| public CATAfrCommandHeaderArgs( | const | ) |
-
Constructs an argument list by copying another one.
o ~CATAfrCommandHeaderArgs
| public virtual ~CATAfrCommandHeaderArgs( | ) |
-
Methods
o CreateIterator
-
Returns an iterator.
Remember to Release the iterator after use.
- Returns:
- The iterator.
o GetArgsCount
-
Get the number of stored arguments.
- Returns:
- The number of stored arguments inside the CATAfrCommandHeaderArgs.
o GetItems
-
Returns the list of arguments as a CATBaseUnknown_var.
This member function is dedicated to internal use.
- Returns:
- The list of arguments converts to a CATBaseUnknown_var.
o Remove
| public Remove( | const | iId) |
-
Remove an argument from its Id.
It will return an error if no argument has this Id.
Special notice on removal: if several iterators concurrently scan the same argument list,
removing an argument in one iterator might impact the scan in the others.
Next, Remove and Set methods of these iterators will have to check the current element still exists
before doing their job and return an error if it does not exist. As soon as an iterator removes an argument,
all the other existing iterators that reference this argument as the current element become unusable
until you call its First method again.
- Parameters:
-
- The
- identifier of the argument to remove.
o RemoveAll
-
Remove all arguments to empty the list.
o Set
| public Set( | const | iId, |
| const | iValue, |
| const | iMode | = CATAfrCommandHeaderArg::In) |
-
Changes the value of an argument from its Id or creates the argument if it does not exist.
An argument can be created only at the end of the existing list.
Set will return an error if the new value type is not compatible with the old value type, i.e.
if types are not the same
or if modes are not the same.
o operator=
| public operator=( | const | ) |
-
Sets an argument list to the contents of another one.
This object is included in the file: CATAfrCommandHeaderArgs.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.